Class CustomSchema<T>

java.lang.Object
io.protostuff.CustomSchema<T>
All Implemented Interfaces:
Schema<T>
public abstract class CustomSchema<T> extends Object implements Schema<T>
A schema (helper class) that wraps another schema and allows its subclasses to override certain methods for more customization.

  • Field Details

    • schema

      protected final Schema<T> schema

  • Constructor Details

    • CustomSchema

      public CustomSchema(Schema<T> schema)

  • Method Details

    • getFieldName

      public 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<T>

    • getFieldNumber

      public 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<T>

    • isInitialized

      public boolean isInitialized(T message)
      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<T>

    • mergeFrom

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

    • messageFullName

      public 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<T>

    • messageName

      public 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<T>

    • newMessage

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

    • typeClass

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

    • writeTo

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