Package org.apache.geode.pdx

Interface PdxWriter

  • public interface PdxWriter
    A PdxWriter will be passed to toData or PdxSerializer toData by GemFire when it is serializing the domain class. The domain class needs to serialize instance fields using this interface. This interface is implemented by GemFire.

    The order in which the fields are written must match the order in which they are read by PdxReader.

    Field names are case sensitive.

    All methods on this interface return itself to allow method calls to be chained together.

    Since:
    GemFire 6.6

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      PdxWriter markIdentityField​(java.lang.String fieldName)
      Indicate that the named field should be included in hashCode and equals checks of this object on a server that is accessing PdxInstance or when a client executes a query on a server.
      PdxWriter writeArrayOfByteArrays​(java.lang.String fieldName, byte[][] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeBoolean​(java.lang.String fieldName, boolean value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeBooleanArray​(java.lang.String fieldName, boolean[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeByte​(java.lang.String fieldName, byte value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeByteArray​(java.lang.String fieldName, byte[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeChar​(java.lang.String fieldName, char value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeCharArray​(java.lang.String fieldName, char[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeDate​(java.lang.String fieldName, java.util.Date value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeDouble​(java.lang.String fieldName, double value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeDoubleArray​(java.lang.String fieldName, double[] value)
      Writes the named field with the given value to the serialized form.
      <CT,​VT extends CT>
      PdxWriter      		 writeField​(java.lang.String fieldName, VT fieldValue, java.lang.Class<CT> fieldType)
      Writes the named field with the given value and type to the serialized form.
      <CT,​VT extends CT>
      PdxWriter      		 writeField​(java.lang.String fieldName, VT fieldValue, java.lang.Class<CT> fieldType, boolean checkPortability)
      Writes the named field with the given value and type to the serialized form.
      PdxWriter writeFloat​(java.lang.String fieldName, float value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeFloatArray​(java.lang.String fieldName, float[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeInt​(java.lang.String fieldName, int value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeIntArray​(java.lang.String fieldName, int[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeLong​(java.lang.String fieldName, long value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeLongArray​(java.lang.String fieldName, long[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeObject​(java.lang.String fieldName, java.lang.Object value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeObject​(java.lang.String fieldName, java.lang.Object value, boolean checkPortability)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeObjectArray​(java.lang.String fieldName, java.lang.Object[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeObjectArray​(java.lang.String fieldName, java.lang.Object[] value, boolean checkPortability)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeShort​(java.lang.String fieldName, short value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeShortArray​(java.lang.String fieldName, short[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeString​(java.lang.String fieldName, java.lang.String value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeStringArray​(java.lang.String fieldName, java.lang.String[] value)
      Writes the named field with the given value to the serialized form.
      PdxWriter writeUnreadFields​(PdxUnreadFields unread)
      Writes the given unread fields to the serialized form.

    • Method Detail

      • writeChar

        PdxWriter writeChar​(java.lang.String fieldName,
                    char value)
        Writes the named field with the given value to the serialized form. The fields type is char.

        Java char is mapped to .NET System.Char.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeBoolean

        PdxWriter writeBoolean​(java.lang.String fieldName,
                       boolean value)
        Writes the named field with the given value to the serialized form. The fields type is boolean.

        Java boolean is mapped to .NET System.Boolean.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeByte

        PdxWriter writeByte​(java.lang.String fieldName,
                    byte value)
        Writes the named field with the given value to the serialized form. The fields type is byte.

        Java byte is mapped to .NET System.SByte.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeShort

        PdxWriter writeShort​(java.lang.String fieldName,
                     short value)
        Writes the named field with the given value to the serialized form. The fields type is short.

        Java short is mapped to .NET System.Int16.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeInt

        PdxWriter writeInt​(java.lang.String fieldName,
                   int value)
        Writes the named field with the given value to the serialized form. The fields type is int.

        Java int is mapped to .NET System.Int32.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeLong

        PdxWriter writeLong​(java.lang.String fieldName,
                    long value)
        Writes the named field with the given value to the serialized form. The fields type is long.

        Java long is mapped to .NET System.Int64.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeFloat

        PdxWriter writeFloat​(java.lang.String fieldName,
                     float value)
        Writes the named field with the given value to the serialized form. The fields type is float.

        Java float is mapped to .NET System.Float.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeDouble

        PdxWriter writeDouble​(java.lang.String fieldName,
                      double value)
        Writes the named field with the given value to the serialized form. The fields type is double.

        Java double is mapped to .NET System.Double.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeDate

        PdxWriter writeDate​(java.lang.String fieldName,
                    java.util.Date value)
        Writes the named field with the given value to the serialized form. The fields type is Date.

        Java Date is mapped to .NET System.DateTime.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeString

        PdxWriter writeString​(java.lang.String fieldName,
                      java.lang.String value)
        Writes the named field with the given value to the serialized form. The fields type is String.

        Java String is mapped to .NET System.String.

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeObject

        PdxWriter writeObject​(java.lang.String fieldName,
                      java.lang.Object value)
        Writes the named field with the given value to the serialized form. The fields type is Object.

        It is best to use one of the other writeXXX methods if your field type will always be XXX. This method allows the field value to be anything that is an instance of Object. This gives you more flexibility but more space is used to store the serialized field.

        Note that some Java objects serialized with this method may not be compatible with non-java languages. To ensure that only portable objects are serialized use writeObject(String, Object, boolean).

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeObject

        PdxWriter writeObject​(java.lang.String fieldName,
                      java.lang.Object value,
                      boolean checkPortability)
        Writes the named field with the given value to the serialized form. The fields type is Object.

        It is best to use one of the other writeXXX methods if your field type will always be XXX. This method allows the field value to be anything that is an instance of Object. This gives you more flexibility but more space is used to store the serialized field.

        Note that some Java objects serialized with this method may not be compatible with non-java languages. To ensure that only portable objects are serialized set the checkPortability parameter to true. The following is a list of the Java classes that are portable and the .NET class they are mapped to:

        • instances of PdxSerializable: .NET class of same name
        • instances of PdxInstance: .NET class of same name
        • instances serialized by a PdxSerializer: .NET class of same name
        • java.lang.Byte: System.SByte
        • java.lang.Boolean: System.Boolean
        • java.lang.Character: System.Char
        • java.lang.Short: System.Int16
        • java.lang.Integer: System.Int32
        • java.lang.Long: System.Int64
        • java.lang.Float: System.Float
        • java.lang.Double: System.Double
        • java.lang.String: System.String
        • java.util.Date: System.DateTime
        • byte[]: System.Byte[]
        • boolean[]: System.Boolean[]
        • char[]: System.Char[]
        • short[]: System.Int16[]
        • int[]: System.Int32[]
        • long[]: System.Int64[]
        • float[]: System.Float[]
        • double[]: System.Double[]
        • String[]: System.String[]
        • byte[][]: System.Byte[][]
        • Object[]: System.Collections.Generic.List<Object>
        • java.util.HashMap: System.Collections.Generics.IDictionary<Object, Object>
        • java.util.Hashtable: System.Collections.Hashtable
        • java.util.ArrayList: System.Collections.Generic.IList<Object>
        • java.util.Vector: System.Collections.ArrayList
        • java.util.HashSet: CacheableHashSet
        • java.util.LinkedHashSet: CacheableLinkedHashSet
        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        checkPortability - if true then an exception is thrown if a non-portable object is serialized
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        NonPortableClassException - if checkPortability is true and a non-portable object is serialized
        PdxSerializationException - if serialization of the field fails.
        Since:
        GemFire 6.6.2

      • writeBooleanArray

        PdxWriter writeBooleanArray​(java.lang.String fieldName,
                            boolean[] value)
        Writes the named field with the given value to the serialized form. The fields type is boolean[].

        Java boolean[] is mapped to .NET System.Boolean[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeCharArray

        PdxWriter writeCharArray​(java.lang.String fieldName,
                         char[] value)
        Writes the named field with the given value to the serialized form. The fields type is char[].

        Java char[] is mapped to .NET System.Char[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeByteArray

        PdxWriter writeByteArray​(java.lang.String fieldName,
                         byte[] value)
        Writes the named field with the given value to the serialized form. The fields type is byte[].

        Java byte[] is mapped to .NET System.Byte[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeShortArray

        PdxWriter writeShortArray​(java.lang.String fieldName,
                          short[] value)
        Writes the named field with the given value to the serialized form. The fields type is short[].

        Java short[] is mapped to .NET System.Int16[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeIntArray

        PdxWriter writeIntArray​(java.lang.String fieldName,
                        int[] value)
        Writes the named field with the given value to the serialized form. The fields type is int[].

        Java int[] is mapped to .NET System.Int32[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeLongArray

        PdxWriter writeLongArray​(java.lang.String fieldName,
                         long[] value)
        Writes the named field with the given value to the serialized form. The fields type is long[].

        Java long[] is mapped to .NET System.Int64[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeFloatArray

        PdxWriter writeFloatArray​(java.lang.String fieldName,
                          float[] value)
        Writes the named field with the given value to the serialized form. The fields type is float[].

        Java float[] is mapped to .NET System.Float[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeDoubleArray

        PdxWriter writeDoubleArray​(java.lang.String fieldName,
                           double[] value)
        Writes the named field with the given value to the serialized form. The fields type is double[].

        Java double[] is mapped to .NET System.Double[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeStringArray

        PdxWriter writeStringArray​(java.lang.String fieldName,
                           java.lang.String[] value)
        Writes the named field with the given value to the serialized form. The fields type is String[].

        Java String[] is mapped to .NET System.String[].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeObjectArray

        PdxWriter writeObjectArray​(java.lang.String fieldName,
                           java.lang.Object[] value)
        Writes the named field with the given value to the serialized form. The fields type is Object[].

        Java Object[] is mapped to .NET System.Collections.Generic.List<Object>. For how each element of the array is a mapped to .NET see writeObject. Note that this call may serialize elements that are not compatible with non-java languages. To ensure that only portable objects are serialized use writeObjectArray(String, Object[], boolean).

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeObjectArray

        PdxWriter writeObjectArray​(java.lang.String fieldName,
                           java.lang.Object[] value,
                           boolean checkPortability)
        Writes the named field with the given value to the serialized form. The fields type is Object[].

        Java Object[] is mapped to .NET System.Collections.Generic.List<Object>. For how each element of the array is a mapped to .NET see writeObject. Note that this call may serialize elements that are not compatible with non-java languages. To ensure that only portable objects are serialized use this method

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        checkPortability - if true then an exception is thrown if a non-portable object is serialized
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        NonPortableClassException - if checkPortability is true and a non-portable element is serialized
        PdxSerializationException - if serialization of the field fails.
        Since:
        GemFire 6.6.2

      • writeArrayOfByteArrays

        PdxWriter writeArrayOfByteArrays​(java.lang.String fieldName,
                                 byte[][] value)
        Writes the named field with the given value to the serialized form. The fields type is byte[][].

        Java byte[][] is mapped to .NET System.Byte[][].

        Parameters:
        fieldName - the name of the field to write
        value - the value of the field to write
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if the named field has already been written
        PdxSerializationException - if serialization of the field fails.

      • writeUnreadFields

        PdxWriter writeUnreadFields​(PdxUnreadFields unread)
        Writes the given unread fields to the serialized form. The unread fields are obtained by calling readUnreadFields.

        This method must be called first before any of the writeXXX methods is called.

        Parameters:
        unread - the object that was returned from readUnreadFields.
        Returns:
        this PdxWriter
        Throws:
        PdxFieldAlreadyExistsException - if one of the writeXXX methods has already been called.

      • markIdentityField

        PdxWriter markIdentityField​(java.lang.String fieldName)
        Indicate that the named field should be included in hashCode and equals checks of this object on a server that is accessing PdxInstance or when a client executes a query on a server. The fields that are marked as identity fields are used to generate the hashCode and equals methods of PdxInstance. Because of this, the identity fields should themselves either be primitives, or implement hashCode and equals. If no fields are set as identity fields, then all fields will be used in hashCode and equals checks. The identity fields should be marked after they are written using a write* method.
        Parameters:
        fieldName - the name of the field to mark as an identity field.
        Returns:
        this PdxWriter
        Throws:
        PdxFieldDoesNotExistException - if the named field has not already been written.