Package 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.

  • Field Details

  • Constructor Details

    • CollectionSchema

      public CollectionSchema(boolean preserveNull)
    • CollectionSchema

      public CollectionSchema(CollectionSchema.MessageFactory messageFactory, boolean preserveNull)
  • Method Details

    • 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)
      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<V>
    • 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<V>
    • isInitialized

      public final boolean isInitialized(Collection<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<V>
    • 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<V>
    • 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<V>
    • typeClass

      public final Class<? super Collection<V>> typeClass()
      Description copied from interface: Schema
      Gets the class of the message.
      Specified by:
      typeClass in interface Schema<V>
    • newMessage

      public final Collection<V> newMessage()
      Description copied from interface: Schema
      Creates the message/object tied to this schema.
      Specified by:
      newMessage in interface Schema<V>
    • mergeFrom

      public void mergeFrom(Input input, Collection<V> message) throws IOException
      Description copied from interface: Schema
      Deserializes a message/object from the input.
      Specified by:
      mergeFrom in interface Schema<V>
      Throws:
      IOException
    • writeWithNullTo

      private void writeWithNullTo(Output output, Collection<V> message) throws IOException
      Throws:
      IOException
    • writeWithoutNullTo

      private void writeWithoutNullTo(Output output, Collection<V> message) throws IOException
      Throws:
      IOException
    • writeTo

      public void writeTo(Output output, Collection<V> message) throws IOException
      Description copied from interface: Schema
      Serializes a message/object to the output.
      Specified by:
      writeTo in interface Schema<V>
      Throws:
      IOException