Class MapSchema<K,V>

java.lang.Object

io.protostuff.MapSchema<K,V>

All Implemented Interfaces:

Schema<Map<K,V>>

Direct Known Subclasses:

MessageMapSchema, StringMapSchema

public abstract class MapSchema<K,V>
extends Object
implements Schema<Map<K,V>>

A schema for a Map. The key and value can be null (depending on the particular map impl).

The default Map message created will be an instance of HashMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MapSchema.MapWrapper<K,V>	A Map.Entry w/c wraps a Map.
static enum	MapSchema.MessageFactories	A message factory for standard Map implementations.
static interface	MapSchema.MessageFactory	Creates new Map messages.

Field Summary

Fields

Modifier and Type	Field	Description
private final Pipe.Schema<Map.Entry<K,V>>	entryPipeSchema
private final Schema<Map.Entry<K,V>>	entrySchema
static final String	FIELD_NAME_ENTRY	The field name of the Map.Entry.
static final String	FIELD_NAME_KEY	The field name of the key.
static final String	FIELD_NAME_VALUE	The field name of the value;
(package private) static final Set<String>	MESSAGE_FACTORIES_NAMES	This is used by MapSchema.MessageFactories.accept(String) method.
final MapSchema.MessageFactory	messageFactory	Factory for creating Map messages.
final Pipe.Schema<Map<K,V>>	pipeSchema	The pipe schema of the Map.

Constructor Summary

Constructors

Constructor	Description
MapSchema()
MapSchema(MapSchema.MessageFactory messageFactory)

Method Summary

Modifier and Type	Method	Description
final String	getFieldName(int number)	Gets the field name associated with the number.
final int	getFieldNumber(String name)	Gets the field number associated with the name.
final boolean	isInitialized(Map<K,V> map)	Returns true if there is no required field or if all the required fields are set.
final void	mergeFrom(Input input, Map<K,V> map)	Deserializes a message/object from the input.
final String	messageFullName()	Returns the full name of the message tied to this schema.
final String	messageName()	Returns the simple name of the message tied to this schema.
final Map<K,V>	newMessage()	Creates the message/object tied to this schema.
protected abstract void	putValueFrom(Input input, MapSchema.MapWrapper<K,V> wrapper, K key)	Puts the entry(key and value), obtained from the input, into the MapWrapper.
protected abstract K	readKeyFrom(Input input, MapSchema.MapWrapper<K,V> wrapper)	Reads the key from the input.
protected abstract void	transferKey(Pipe pipe, Input input, Output output, int number, boolean repeated)	Transfers the key from the input to the output.
protected abstract void	transferValue(Pipe pipe, Input input, Output output, int number, boolean repeated)	Transfers the value from the input to the output.
final Class<? super Map<K,V>>	typeClass()	Gets the class of the message.
protected abstract void	writeKeyTo(Output output, int fieldNumber, K value, boolean repeated)	Writes the key to the output.
final void	writeTo(Output output, Map<K,V> map)	Serializes a message/object to the output.
protected abstract void	writeValueTo(Output output, int fieldNumber, V value, boolean repeated)	Writes the value to the output.

Methods inherited from class Object

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

Field Details

MESSAGE_FACTORIES_NAMES

static final Set<String> MESSAGE_FACTORIES_NAMES

This is used by MapSchema.MessageFactories.accept(String) method. Rather than iterating enums in runtime which can be an expensive way to do, caching all the enums as static property will be a good way.

FIELD_NAME_ENTRY

public static final String FIELD_NAME_ENTRY

The field name of the Map.Entry.

See Also:

• Constant Field Values

FIELD_NAME_KEY

public static final String FIELD_NAME_KEY

The field name of the key.

See Also:

• Constant Field Values

FIELD_NAME_VALUE

public static final String FIELD_NAME_VALUE

The field name of the value;

See Also:

• Constant Field Values

messageFactory

public final MapSchema.MessageFactory messageFactory

Factory for creating Map messages.

pipeSchema

public final Pipe.Schema<Map<K,V>> pipeSchema

The pipe schema of the Map.

entrySchema

private final Schema<Map.Entry<K,V>> entrySchema

entryPipeSchema

private final Pipe.Schema<Map.Entry<K,V>> entryPipeSchema

Constructor Details

MapSchema

public MapSchema()

MapSchema

public MapSchema(MapSchema.MessageFactory messageFactory)

Method Details

readKeyFrom

protected abstract K readKeyFrom(Input input,
 MapSchema.MapWrapper<K,V> wrapper)
                          throws IOException

Reads the key from the input.

The extra wrapper arg is internally used as an object placeholder during polymorhic deserialization.

Throws:

IOException

putValueFrom

protected abstract void putValueFrom(Input input,
 MapSchema.MapWrapper<K,V> wrapper,
 K key)
                              throws IOException

Puts the entry(key and value), obtained from the input, into the MapWrapper.

Throws:

IOException

writeKeyTo

protected abstract void writeKeyTo(Output output,
 int fieldNumber,
 K value,
 boolean repeated)
                            throws IOException

Writes the key to the output.

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

transferKey

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

Transfers the key from the input 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)

Description copied from interface: Schema

Gets the field name associated with the number. This is particularly useful when serializing to different formats (Eg. JSON). When using numeric field names:

return String.valueOf(number);

Specified by:

getFieldName in interface Schema<K>

getFieldNumber

public final int getFieldNumber(String name)

Description copied from interface: Schema

Gets the field number associated with the name. This is particularly useful when serializing to different formats (Eg. JSON). When using numeric field names:

return Integer.parseInt(name);

Specified by:

getFieldNumber in interface Schema<K>

isInitialized

public final boolean isInitialized(Map<K,V> map)

Description copied from interface: Schema

Returns true if there is no required field or if all the required fields are set.

Specified by:

isInitialized in interface Schema<K>

messageFullName

public final String messageFullName()

Description copied from interface: Schema

Returns the full name of the message tied to this schema. Allows custom schemas to provide a custom name other than typeClass().getName();

Specified by:

messageFullName in interface Schema<K>

messageName

public final String messageName()

Description copied from interface: Schema

Returns the simple name of the message tied to this schema. Allows custom schemas to provide a custom name other than typeClass().getSimpleName();

Specified by:

messageName in interface Schema<K>

typeClass

public final Class<? super Map<K,V>> typeClass()

Description copied from interface: Schema

Gets the class of the message.

Specified by:

typeClass in interface Schema<K>

newMessage

public final Map<K,V> newMessage()

Description copied from interface: Schema

Creates the message/object tied to this schema.

Specified by:

newMessage in interface Schema<K>

mergeFrom

public final void mergeFrom(Input input,
 Map<K,V> map)
                     throws IOException

Description copied from interface: Schema

Deserializes a message/object from the input.

Specified by:

mergeFrom in interface Schema<K>

Throws:

IOException

writeTo

public final void writeTo(Output output,
 Map<K,V> map)
                   throws IOException

Description copied from interface: Schema

Serializes a message/object to the output.

Specified by:

writeTo in interface Schema<K>

Throws:

IOException