com.dyuproject.protostuff

Class StringMapSchema<V>

java.lang.Object

com.dyuproject.protostuff.MapSchema<java.lang.String,V>

com.dyuproject.protostuff.StringMapSchema<V>

All Implemented Interfaces:

Schema<java.util.Map<java.lang.String,V>>

public class StringMapSchema<V>
extends MapSchema<java.lang.String,V>

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

Author:

David Yu

Date created:

Jun 25, 2010

Nested Class Summary

Nested classes/interfaces inherited from class com.dyuproject.protostuff.MapSchema

MapSchema.MapWrapper<K,V>, MapSchema.MessageFactories, MapSchema.MessageFactory

Field Summary

Fields

Modifier and Type	Field and Description
static StringMapSchema<java.lang.String>	VALUE_STRING The schema for Map
Pipe.Schema<V>	vPipeSchema The pipe schema of the message value.
Schema<V>	vSchema The schema of the message value.

Fields inherited from class com.dyuproject.protostuff.MapSchema

FIELD_NAME_ENTRY, FIELD_NAME_KEY, FIELD_NAME_VALUE, messageFactory, pipeSchema

Constructor Summary

Constructors

Constructor and Description
StringMapSchema(Schema<V> vSchema)
StringMapSchema(Schema<V> vSchema, Pipe.Schema<V> vPipeSchema)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	putValueFrom(Input input, MapSchema.MapWrapper<java.lang.String,V> wrapper, java.lang.String key) Puts the entry(key and value), obtained from the input, into the MapWrapper.
protected java.lang.String	readKeyFrom(Input input, MapSchema.MapWrapper<java.lang.String,V> wrapper) Reads the key from the input.
protected void	transferKey(Pipe pipe, Input input, Output output, int number, boolean repeated) Transfers the key from the input to the output.
protected void	transferValue(Pipe pipe, Input input, Output output, int number, boolean repeated) Transfers the value from the input to the output.
protected void	writeKeyTo(Output output, int fieldNumber, java.lang.String value, boolean repeated) Writes the key to the output.
protected void	writeValueTo(Output output, int fieldNumber, V value, boolean repeated) Writes the value to the output.

Methods inherited from class com.dyuproject.protostuff.MapSchema

getFieldName, getFieldNumber, isInitialized, mergeFrom, messageFullName, messageName, newMessage, typeClass, writeTo

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_STRING

public static final StringMapSchema<java.lang.String> VALUE_STRING

The schema for Map

vSchema

public final Schema<V> vSchema

The schema of the message value.

vPipeSchema

public final Pipe.Schema<V> vPipeSchema

The pipe schema of the message value.

Constructor Detail

StringMapSchema

public StringMapSchema(Schema<V> vSchema)

StringMapSchema

public StringMapSchema(Schema<V> vSchema,
               Pipe.Schema<V> vPipeSchema)

Method Detail

readKeyFrom

protected final java.lang.String readKeyFrom(Input input,
                           MapSchema.MapWrapper<java.lang.String,V> wrapper)
                                      throws java.io.IOException

Description copied from class: MapSchema

Reads the key from the input. The extra wrapper arg is internally used as an object placeholder during polymorhic deserialization.

Specified by:

readKeyFrom in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException

putValueFrom

protected void putValueFrom(Input input,
                MapSchema.MapWrapper<java.lang.String,V> wrapper,
                java.lang.String key)
                     throws java.io.IOException

Description copied from class: MapSchema

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

Specified by:

putValueFrom in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException

writeKeyTo

protected final void writeKeyTo(Output output,
              int fieldNumber,
              java.lang.String value,
              boolean repeated)
                         throws java.io.IOException

Description copied from class: MapSchema

Writes the key to the output.

Specified by:

writeKeyTo in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException

writeValueTo

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

Description copied from class: MapSchema

Writes the value to the output.

Specified by:

writeValueTo in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException

transferKey

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

Description copied from class: MapSchema

Transfers the key from the input to the output.

Specified by:

transferKey in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException

transferValue

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

Description copied from class: MapSchema

Transfers the value from the input to the output.

Specified by:

transferValue in class MapSchema<java.lang.String,V>

Throws:

java.io.IOException