Interface Serializer


  • public interface Serializer
    Schnittstelle zum Serialisieren von Datensätzen. Konkrete Objekte zum Serialisieren können mit den verschiedenen Methoden der Klasse SerializingFactory erzeugt werden. Dabei kann der Ausgabe-Stream für die Serialisierung vorgegeben werden.

    Mit den verschiedenen write-Methoden können primitive Datentypen, Referenzen auf System-Objekte und ganze Datensätze auf einen OutputStream serialisiert werden.

    Über die getVersion() Methode kann die Version eines konkreten Serialisieres abgefragt werden.

    See Also:
    Deserializer
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.io.OutputStream getOutputStream()
      Bestimmt den für die Serialisierung zu verwendenden Ausgabe-Stream.
      int getVersion()
      Bestimmt die Version des konkreten Serialisierers.
      void setOutputStream​(java.io.OutputStream outputStream)
      Setzt den zu verwendenden Ausgabe-Stream.
      void writeBoolean​(boolean value)
      Serialisiert einen boolean-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeByte​(int value)
      Serialisiert einen byte-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeBytes​(byte[] bytes)
      Schreibt ein Byte-Array auf den Ausgabe-Stream.
      void writeBytes​(byte[] bytes, int offset, int length)
      Schreibt ein Folge von Bytes aus einem Byte-Array auf den Ausgabe-Stream.
      void writeData​(Data data)
      Serialisiert einen Datensatz in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeDouble​(double value)
      Serialisiert einen double-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeFloat​(float value)
      Serialisiert einen float-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeInt​(int value)
      Serialisiert einen int-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeLong​(long value)
      Serialisiert einen long-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeObjectReference​(SystemObject object)
      Serialisiert die id eines Systemobjekts in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeShort​(int value)
      Serialisiert einen short-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeString​(java.lang.String value)
      Serialisiert einen String-Wert mit einer maximalLänge von 65535 in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
      void writeString​(java.lang.String value, int maxLength)
      Serialisiert einen String-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
    • Method Detail

      • getVersion

        int getVersion()
        Bestimmt die Version des konkreten Serialisierers.
        Returns:
        Version des Serialisierers.
      • getOutputStream

        java.io.OutputStream getOutputStream()
        Bestimmt den für die Serialisierung zu verwendenden Ausgabe-Stream.
        Returns:
        Für die Serialisierung zu verwendenden Ausgabe-Stream.
      • setOutputStream

        void setOutputStream​(java.io.OutputStream outputStream)
        Setzt den zu verwendenden Ausgabe-Stream.
        Parameters:
        outputStream - Zu verwendender Ausgabe-Stream
      • writeData

        void writeData​(Data data)
                throws java.io.IOException
        Serialisiert einen Datensatz in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        data - Der zu serialisierende Datensatz.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeBoolean

        void writeBoolean​(boolean value)
                   throws java.io.IOException
        Serialisiert einen boolean-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler beim Schreiben auf den Ausgabe-Strom auftritt.
      • writeObjectReference

        void writeObjectReference​(SystemObject object)
                           throws java.io.IOException
        Serialisiert die id eines Systemobjekts in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        object - Das Systemobjekt dessen id serialisiert werden soll.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeLong

        void writeLong​(long value)
                throws java.io.IOException
        Serialisiert einen long-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeInt

        void writeInt​(int value)
               throws java.io.IOException
        Serialisiert einen int-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeShort

        void writeShort​(int value)
                 throws java.io.IOException
        Serialisiert einen short-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeByte

        void writeByte​(int value)
                throws java.io.IOException
        Serialisiert einen byte-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeDouble

        void writeDouble​(double value)
                  throws java.io.IOException
        Serialisiert einen double-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeFloat

        void writeFloat​(float value)
                 throws java.io.IOException
        Serialisiert einen float-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeString

        void writeString​(java.lang.String value)
                  throws java.io.IOException
        Serialisiert einen String-Wert mit einer maximalLänge von 65535 in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream.
        Parameters:
        value - Der zu serialisierende Wert.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
        java.lang.IllegalArgumentException - Wenn die Länge des Strings größer als 65535 Zeichen ist.
      • writeString

        void writeString​(java.lang.String value,
                         int maxLength)
                  throws java.io.IOException
        Serialisiert einen String-Wert in einen Bytestrom und schreibt diesen auf den Ausgabe-Stream. Es ist zu beachten, dass beim Deserialiseren die gleiche Maximalgröße wie beim serialisieren angegeben wird.
        Parameters:
        value - Der zu serialisierende Wert.
        maxLength - Maximale Länge des zu serialisierenden Strings oder 0 wenn keine Begrenzung vorgegeben werden kann.
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
        java.lang.IllegalArgumentException - Wenn die Länge des Strings größer als die angegebene Maximallänge ist.
      • writeBytes

        void writeBytes​(byte[] bytes)
                 throws java.io.IOException
        Schreibt ein Byte-Array auf den Ausgabe-Stream. Es ist zu beachten, dass die Größe des Arrays nicht implizit serialisiert wird und beim Deserialisieren angegeben werden muss.
        Parameters:
        bytes - Zu schreibendes Byte-Array
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.
      • writeBytes

        void writeBytes​(byte[] bytes,
                        int offset,
                        int length)
                 throws java.io.IOException
        Schreibt ein Folge von Bytes aus einem Byte-Array auf den Ausgabe-Stream. Es ist zu beachten, dass die Anzahl der Bytes nicht implizit serialisiert wird und beim Deserialisieren passend angegeben werden muss.
        Parameters:
        bytes - Byte-Array mit den zu schreibenden Bytes
        offset - Start-Offset des ersten zu schreibenden Bytes im Array
        length - Anzahl der zu schreibenden Bytes
        Throws:
        java.io.IOException - Wenn ein I/O Fehler bei Schreiben auf den Ausgabe-Stream auftritt.