Package com.google.crypto.tink.internal

Class ParametersParser

java.lang.Object

com.google.crypto.tink.internal.ParametersParser

public abstract class ParametersParser
extends java.lang.Object

Parses Serialization objects into Parameters objects of a certain kind.

This class should eventually be in Tinks public API -- however, it might still change before that.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParametersParser.ParametersParsingFunction	A function which parses a Parameters object.

Method Summary

Modifier and Type	Method	Description
static ParametersParser	create(ParametersParser.ParametersParsingFunction function, java.lang.String typeUrl)	Creates a ParametersParser object.
java.lang.Class<ProtoParametersSerialization>	getSerializationClass()
java.lang.String	getTypeUrl()	Returns the getTypeUrl for this serialization.
abstract Parameters	parseParameters(ProtoParametersSerialization serialization)	Parses a serialization into a Parameters object.

Methods inherited from class java.lang.Object

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

Method Detail

parseParameters

public abstract Parameters parseParameters(ProtoParametersSerialization serialization)
                                    throws java.security.GeneralSecurityException

Parses a serialization into a Parameters object.

This function is usually called with a Serialization matching the result of getObjectIdentifier. However, implementations should check that this is the case.

Throws:

java.security.GeneralSecurityException

getTypeUrl

public final java.lang.String getTypeUrl()

Returns the getTypeUrl for this serialization.

getSerializationClass

public final java.lang.Class<ProtoParametersSerialization> getSerializationClass()

create

public static ParametersParser create(ParametersParser.ParametersParsingFunction function,
                                      java.lang.String typeUrl)

Creates a ParametersParser object.

In order to create a ParametersParser object, one typically writes a function

 class MyClass {
   private static MyParameters parse(ProtoParametersSerialization parametersSerialization)
             throws GeneralSecurityException {
     ...
   }
 }
 

This function can then be used to create a ParametersParser:

 ParametersParser parser =
       ParametersParser.create(MyClass::parse, objectIdentifier);
 

Parameters:

function - The function used to parse a Parameters object.

objectIdentifier - The identifier to be returned by #getObjectIdentifier