io.protostuff

Class CollectionSchema<V>

java.lang.Object

io.protostuff.CollectionSchema<V>

All Implemented Interfaces:

Schema<Collection<V>>

Direct Known Subclasses:

MessageCollectionSchema

public abstract class CollectionSchema<V>
extends Object
implements Schema<Collection<V>>

A schema for standard jdk collections. Null values are not serialized/written.

If preserveNull is false and your application relies on Object.equals(Object), it will fail when a serialized collection contains null values.

Author:

David Yu

Date created:

Jan 26, 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionSchema.MessageFactories
static interface	CollectionSchema.MessageFactory Creates new Collection messages.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_NAME_NULL
static String	FIELD_NAME_VALUE
CollectionSchema.MessageFactory	messageFactory Factory for creating Collection messages.
Pipe.Schema<Collection<V>>	pipeSchema
boolean	preserveNull

Constructor Summary

Constructors

Constructor and Description
CollectionSchema(boolean preserveNull)
CollectionSchema(CollectionSchema.MessageFactory messageFactory, boolean preserveNull)

Method Summary

Modifier and Type	Method and Description
protected abstract void	addValueFrom(Input input, Collection<V> collection) Adds the value from the input into the Collection.
static String	fieldName(int number)
static int	fieldNumber(String name)
String	getFieldName(int number)
int	getFieldNumber(String name)
boolean	isInitialized(Collection<V> map)
void	mergeFrom(Input input, Collection<V> message)
String	messageFullName()
String	messageName()
Collection<V>	newMessage()
protected abstract void	transferValue(Pipe pipe, Input input, Output output, int number, boolean repeated) Transfers the value from the input to the output.
Class<? super Collection<V>>	typeClass()
void	writeTo(Output output, Collection<V> message)
protected abstract void	writeValueTo(Output output, int fieldNumber, V value, boolean repeated) Writes the value to the output.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_NAME_VALUE

public static final String FIELD_NAME_VALUE

See Also:

Constant Field Values

FIELD_NAME_NULL

public static final String FIELD_NAME_NULL

See Also:

Constant Field Values

messageFactory

public final CollectionSchema.MessageFactory messageFactory

Factory for creating Collection messages.

preserveNull

public final boolean preserveNull

pipeSchema

public final Pipe.Schema<Collection<V>> pipeSchema

Constructor Detail

CollectionSchema

public CollectionSchema(boolean preserveNull)

CollectionSchema

public CollectionSchema(CollectionSchema.MessageFactory messageFactory,
                        boolean preserveNull)

Method Detail

fieldName

public static final String fieldName(int number)

fieldNumber

public static final int fieldNumber(String name)

addValueFrom

protected abstract void addValueFrom(Input input,
                                     Collection<V> collection)
                              throws IOException

Adds the value from the input into the Collection.

Throws:

IOException

writeValueTo

protected abstract void writeValueTo(Output output,
                                     int fieldNumber,
                                     V value,
                                     boolean repeated)
                              throws IOException

Writes the value to the output.

Throws:

IOException

transferValue

protected abstract void transferValue(Pipe pipe,
                                      Input input,
                                      Output output,
                                      int number,
                                      boolean repeated)
                               throws IOException

Transfers the value from the input to the output.

Throws:

IOException

getFieldName

public final String getFieldName(int number)

Specified by:

getFieldName in interface Schema<Collection<V>>

getFieldNumber

public final int getFieldNumber(String name)

Specified by:

getFieldNumber in interface Schema<Collection<V>>

isInitialized

public final boolean isInitialized(Collection<V> map)

Specified by:

isInitialized in interface Schema<Collection<V>>

messageFullName

public final String messageFullName()

Specified by:

messageFullName in interface Schema<Collection<V>>

messageName

public final String messageName()

Specified by:

messageName in interface Schema<Collection<V>>

typeClass

public final Class<? super Collection<V>> typeClass()

Specified by:

typeClass in interface Schema<Collection<V>>

newMessage

public final Collection<V> newMessage()

Specified by:

newMessage in interface Schema<Collection<V>>

mergeFrom

public void mergeFrom(Input input,
                      Collection<V> message)
               throws IOException

Specified by:

mergeFrom in interface Schema<Collection<V>>

Throws:

IOException

writeTo

public void writeTo(Output output,
                    Collection<V> message)
             throws IOException

Specified by:

writeTo in interface Schema<Collection<V>>

Throws:

IOException