Module org.refcodes.serial
Package org.refcodes.serial

Class AbstractSegmentDecorator<SEGMENT extends Segment>

java.lang.Object
org.refcodes.serial.AbstractTransmissionDecorator<SEGMENT>
org.refcodes.serial.AbstractSegmentDecorator<SEGMENT>
Type Parameters:
SEGMENT - The Segment type describing the Segment subclass to be enriched.
All Implemented Interfaces:
Serializable, org.refcodes.mixin.DecorateeAccessor<SEGMENT>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Resetable, org.refcodes.schema.Schemable, Segment, Transmission, Transmission.TransmissionMixin
public class AbstractSegmentDecorator<SEGMENT extends Segment> extends AbstractTransmissionDecorator<SEGMENT> implements Segment
Convenience class for easily decorating a Segment.
See Also:

  • Constructor Details

    • AbstractSegmentDecorator

      public AbstractSegmentDecorator()

    • AbstractSegmentDecorator

      public AbstractSegmentDecorator(SEGMENT aDecoratee)
      Instantiates a new abstract segment decorator.
      Parameters:
      aDecoratee - the a decoratee

  • Method Details

    • transmitTo

      public void transmitTo(OutputStream aOutputStream, InputStream aReturnStream) throws IOException
      Transmits the Sequence representing the implementing type's instance to the given OutputStream. Implementations providing error correction methods use the provided feedback InputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the transmitted data.
      Specified by:
      transmitTo in interface Transmission
      Specified by:
      transmitTo in interface Transmission.TransmissionMixin
      Parameters:
      aOutputStream - The OutputStream where to write this instance's Sequence to.
      aReturnStream - An InputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.
      Throws:
      IOException - thrown in case writing data to the OutputStream caused problems.

    • toSchema

      public SerialSchema toSchema()
      Specified by:
      toSchema in interface org.refcodes.schema.Schemable
      Specified by:
      toSchema in interface Transmission

    • fromTransmission

      public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
      (Re-)initializes this instance with the the given Sequence data.
      Specified by:
      fromTransmission in interface Segment
      Parameters:
      aSequence - The Sequence data from which to (re-)initialize this instance.
      aOffset - The offset where to start processing the provided Sequence.
      Returns:
      The index after the last offset into the given Sequence processed by this method.
      Throws:
      TransmissionException - thrown in case a given Sequence cannot be processed.

    • receiveFrom

      public void receiveFrom(InputStream aInputStream, OutputStream aReturnStream) throws IOException
      (Re-)initializes this instance by receiving the according Sequence from the given InputStream. Implementations providing error correction methods use the provided feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.
      Specified by:
      receiveFrom in interface Segment
      Parameters:
      aInputStream - The InputStream from which to read the instance's (re-)initialization Sequence from.
      aReturnStream - An OutputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.
      Throws:
      IOException - thrown in case reading data from the InputStream caused problems.
      TransmissionException - thrown in case a given transmission cannot be processed.