com.google.crypto.tink.internal

Class PrimitiveConstructor<KeyT extends Key,PrimitiveT>

java.lang.Object

com.google.crypto.tink.internal.PrimitiveConstructor<KeyT,PrimitiveT>

public abstract class PrimitiveConstructor<KeyT extends Key,PrimitiveT>
extends Object

Create Primitive objects from Key objects of a certain kind.

This class should eventually be in Tinks public API -- however, it might still change before that. Note: Before making this public, the class name should be reconsidered. (Currently the desirable option "PrimitiveFactory" is unavailable because such a class already exists.)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PrimitiveConstructor.PrimitiveConstructionFunction<KeyT extends Key,PrimitiveT> A function which creates a Primitive object.

Method Summary

Modifier and Type	Method and Description
abstract PrimitiveT	constructPrimitive(KeyT key)
static <KeyT extends Key,PrimitiveT> PrimitiveConstructor<KeyT,PrimitiveT>	create(PrimitiveConstructor.PrimitiveConstructionFunction<KeyT,PrimitiveT> function, Class<KeyT> keyClass, Class<PrimitiveT> primitiveClass) Creates a PrimitiveConstructor object.
Class<KeyT>	getKeyClass()
Class<PrimitiveT>	getPrimitiveClass()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

constructPrimitive

public abstract PrimitiveT constructPrimitive(KeyT key)
                                       throws GeneralSecurityException

Throws:

GeneralSecurityException

getKeyClass

public Class<KeyT> getKeyClass()

getPrimitiveClass

public Class<PrimitiveT> getPrimitiveClass()

create

public static <KeyT extends Key,PrimitiveT> PrimitiveConstructor<KeyT,PrimitiveT> create(PrimitiveConstructor.PrimitiveConstructionFunction<KeyT,PrimitiveT> function,
                                                                                         Class<KeyT> keyClass,
                                                                                         Class<PrimitiveT> primitiveClass)

Creates a PrimitiveConstructor object.

This function should only be used by Primitives authors, that is, end users should almost certainly avoid using this function directly, and instead use their respective Primitive's register() method.

That being said, one typically creates a PrimitiveConstructor object by writing a function

 class MyClass {
   private static MyPrimitive getPrimitive(MyKey key)
             throws GeneralSecurityException {
     ...
   }
 }
 

This function can then be used to create a PrimitiveConstructor:

 PrimitiveConstructor<MyKey, MyPrimitive> serializer =
       PrimitiveConstructor.create(MyClass::getPrimitive, MyKey.class,
                                  MyPrimitive.class);
 

-- and the resulting PrimitiveConstructor object can in turn be registered in a PrimitiveRegistry.