io.protostuff

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.

Author:

David Yu

Date created:

Jun 26, 2010

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_NAME_ENTRY The field name of the Map.Entry.
static String	FIELD_NAME_KEY The field name of the key.
static String	FIELD_NAME_VALUE The field name of the value;
MapSchema.MessageFactory	messageFactory Factory for creating Map messages.
Pipe.Schema<Map<K,V>>	pipeSchema The pipe schema of the Map.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getFieldName(int number)
int	getFieldNumber(String name)
boolean	isInitialized(Map<K,V> map)
void	mergeFrom(Input input, Map<K,V> map)
String	messageFullName()
String	messageName()
Map<K,V>	newMessage()
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.
Class<? super Map<K,V>>	typeClass()
protected abstract void	writeKeyTo(Output output, int fieldNumber, K value, boolean repeated) Writes the key to the output.
void	writeTo(Output output, Map<K,V> map)
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_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.

Constructor Detail

MapSchema

public MapSchema()

MapSchema

public MapSchema(MapSchema.MessageFactory messageFactory)

Method Detail

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)

Specified by:

getFieldName in interface Schema<Map<K,V>>

getFieldNumber

public final int getFieldNumber(String name)

Specified by:

getFieldNumber in interface Schema<Map<K,V>>

isInitialized

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

Specified by:

isInitialized in interface Schema<Map<K,V>>

messageFullName

public final String messageFullName()

Specified by:

messageFullName in interface Schema<Map<K,V>>

messageName

public final String messageName()

Specified by:

messageName in interface Schema<Map<K,V>>

typeClass

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

Specified by:

typeClass in interface Schema<Map<K,V>>

newMessage

public final Map<K,V> newMessage()

Specified by:

newMessage in interface Schema<Map<K,V>>

mergeFrom

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

Specified by:

mergeFrom in interface Schema<Map<K,V>>

Throws:

IOException

writeTo

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

Specified by:

writeTo in interface Schema<Map<K,V>>

Throws:

IOException