io.protostuff.runtime

Class RuntimeSchema<T>

java.lang.Object

io.protostuff.runtime.RuntimeSchema<T>

All Implemented Interfaces:

Schema<T>

public final class RuntimeSchema<T>
extends Object
implements Schema<T>

A schema that can be generated and cached at runtime for objects that have no schema. This is particularly useful for pojos from 3rd party libraries.

Author:

David Yu

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERROR_TAG_VALUE
RuntimeEnv.Instantiator<T>	instantiator
static int	MAX_TAG_VALUE
static int	MIN_TAG_FOR_HASH_FIELD_MAP
static int	MIN_TAG_VALUE

Constructor Summary

Constructors

Constructor and Description
RuntimeSchema(Class<T> typeClass, Collection<Field<T>> fields, Constructor<T> constructor)
RuntimeSchema(Class<T> typeClass, Collection<Field<T>> fields, RuntimeEnv.Instantiator<T> instantiator)

Method Summary

Modifier and Type	Method and Description
static <T> RuntimeSchema<T>	createFrom(Class<T> typeClass) Generates a schema from the given class.
static <T> RuntimeSchema<T>	createFrom(Class<T> typeClass, IdStrategy strategy) Generates a schema from the given class.
static <T> RuntimeSchema<T>	createFrom(Class<T> typeClass, Map<String,String> declaredFields, IdStrategy strategy) Generates a schema from the given class with the declared fields (inclusive) based from the given Map.
static <T> RuntimeSchema<T>	createFrom(Class<T> typeClass, Set<String> exclusions, IdStrategy strategy) Generates a schema from the given class with the exclusion of certain fields.
static <T> RuntimeSchema<T>	createFrom(Class<T> typeClass, String[] exclusions, IdStrategy strategy) Generates a schema from the given class with the exclusion of certain fields.
Field<T>	getFieldByName(String fieldName)
Field<T>	getFieldByNumber(int n)
int	getFieldCount()
String	getFieldName(int number)
int	getFieldNumber(String name)
List<Field<T>>	getFields()
Pipe.Schema<T>	getPipeSchema() Returns the pipe schema linked to this.
static <T> Schema<T>	getSchema(Class<T> typeClass) Gets the schema that was either registered or lazily initialized at runtime.
static <T> Schema<T>	getSchema(Class<T> typeClass, IdStrategy strategy) Gets the schema that was either registered or lazily initialized at runtime.
boolean	isInitialized(T message) Always returns true, everything is optional.
static boolean	isRegistered(Class<?> typeClass) Returns true if the typeClass was not lazily created.
static boolean	isRegistered(Class<?> typeClass, IdStrategy strategy) Returns true if the typeClass was not lazily created.
static <T> boolean	map(Class<? super T> baseClass, Class<T> typeClass) Maps the baseClass to a specific non-interface/non-abstract typeClass and registers it (this must be done on application startup).
void	mergeFrom(Input input, T message)
String	messageFullName()
String	messageName()
T	newMessage()
static <T> boolean	register(Class<T> typeClass) Returns true if this there is no existing one or the same schema has already been registered (this must be done on application startup).
static <T> boolean	register(Class<T> typeClass, Schema<T> schema) Returns true if this there is no existing one or the same schema has already been registered (this must be done on application startup).
Class<T>	typeClass()
void	writeTo(Output output, T message)

Methods inherited from class java.lang.Object

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

Field Detail

MIN_TAG_VALUE

public static final int MIN_TAG_VALUE

See Also:

Constant Field Values

MAX_TAG_VALUE

public static final int MAX_TAG_VALUE

See Also:

Constant Field Values

ERROR_TAG_VALUE

public static final String ERROR_TAG_VALUE

See Also:

Constant Field Values

MIN_TAG_FOR_HASH_FIELD_MAP

public static final int MIN_TAG_FOR_HASH_FIELD_MAP

See Also:

Constant Field Values

instantiator

public final RuntimeEnv.Instantiator<T> instantiator

Constructor Detail

RuntimeSchema

public RuntimeSchema(Class<T> typeClass,
                     Collection<Field<T>> fields,
                     Constructor<T> constructor)

RuntimeSchema

public RuntimeSchema(Class<T> typeClass,
                     Collection<Field<T>> fields,
                     RuntimeEnv.Instantiator<T> instantiator)

Method Detail

map

public static <T> boolean map(Class<? super T> baseClass,
                              Class<T> typeClass)

Maps the baseClass to a specific non-interface/non-abstract typeClass and registers it (this must be done on application startup).

With this approach, there is no overhead of writing the type metadata if a baseClass field is serialized.

Returns true if the baseClass does not exist.

NOTE: This is only supported when RuntimeEnv.ID_STRATEGY is DefaultIdStrategy.

Throws:

IllegalArgumentException - if the typeClass is an interface or an abstract class.

register

public static <T> boolean register(Class<T> typeClass,
                                   Schema<T> schema)

Returns true if this there is no existing one or the same schema has already been registered (this must be done on application startup).

NOTE: This is only supported when RuntimeEnv.ID_STRATEGY is DefaultIdStrategy.

register

public static <T> boolean register(Class<T> typeClass)

Returns true if this there is no existing one or the same schema has already been registered (this must be done on application startup).

NOTE: This is only supported when RuntimeEnv.ID_STRATEGY is DefaultIdStrategy.

isRegistered

public static boolean isRegistered(Class<?> typeClass)

Returns true if the typeClass was not lazily created.

Method overload for backwards compatibility.

isRegistered

public static boolean isRegistered(Class<?> typeClass,
                                   IdStrategy strategy)

Returns true if the typeClass was not lazily created.

getSchema

public static <T> Schema<T> getSchema(Class<T> typeClass)

Gets the schema that was either registered or lazily initialized at runtime.

Method overload for backwards compatibility.

getSchema

public static <T> Schema<T> getSchema(Class<T> typeClass,
                                      IdStrategy strategy)

Gets the schema that was either registered or lazily initialized at runtime.

createFrom

public static <T> RuntimeSchema<T> createFrom(Class<T> typeClass)

Generates a schema from the given class.

Method overload for backwards compatibility.

createFrom

public static <T> RuntimeSchema<T> createFrom(Class<T> typeClass,
                                              IdStrategy strategy)

Generates a schema from the given class.

createFrom

public static <T> RuntimeSchema<T> createFrom(Class<T> typeClass,
                                              String[] exclusions,
                                              IdStrategy strategy)

Generates a schema from the given class with the exclusion of certain fields.

createFrom

public static <T> RuntimeSchema<T> createFrom(Class<T> typeClass,
                                              Set<String> exclusions,
                                              IdStrategy strategy)

Generates a schema from the given class with the exclusion of certain fields.

createFrom

public static <T> RuntimeSchema<T> createFrom(Class<T> typeClass,
                                              Map<String,String> declaredFields,
                                              IdStrategy strategy)

Generates a schema from the given class with the declared fields (inclusive) based from the given Map. The value of a the Map's entry will be the name used for the field (which enables aliasing).

getPipeSchema

public Pipe.Schema<T> getPipeSchema()

Returns the pipe schema linked to this.

getFieldByNumber

public Field<T> getFieldByNumber(int n)

getFieldByName

public Field<T> getFieldByName(String fieldName)

getFieldCount

public int getFieldCount()

getFields

public List<Field<T>> getFields()

typeClass

public Class<T> typeClass()

Specified by:

typeClass in interface Schema<T>

messageName

public String messageName()

Specified by:

messageName in interface Schema<T>

messageFullName

public String messageFullName()

Specified by:

messageFullName in interface Schema<T>

getFieldName

public String getFieldName(int number)

Specified by:

getFieldName in interface Schema<T>

getFieldNumber

public int getFieldNumber(String name)

Specified by:

getFieldNumber in interface Schema<T>

mergeFrom

public final void mergeFrom(Input input,
                            T message)
                     throws IOException

Specified by:

mergeFrom in interface Schema<T>

Throws:

IOException

writeTo

public final void writeTo(Output output,
                          T message)
                   throws IOException

Specified by:

writeTo in interface Schema<T>

Throws:

IOException

isInitialized

public boolean isInitialized(T message)

Always returns true, everything is optional.

Specified by:

isInitialized in interface Schema<T>

newMessage

public T newMessage()

Specified by:

newMessage in interface Schema<T>