Module org.refcodes.io
Package org.refcodes.io

Class ShortTransmitterDecorator

java.lang.Object
org.refcodes.component.AbstractConnectable
org.refcodes.component.AbstractConnectableAutomaton
org.refcodes.io.AbstractShortsTransmitter
org.refcodes.io.ShortTransmitterDecorator
All Implemented Interfaces:
Flushable, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.OpenedAccessor, ShortSource, ShortsSource, ShortsTransmitter, ShortTransmitter, Transmittable
public class ShortTransmitterDecorator extends AbstractShortsTransmitter
The ShortTransmitterDecorator decorates a ShortsSource with the additional methods of a ShortsTransmitter making it easy to use a ShortsSource wherever a ShortsTransmitter is expected.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.refcodes.component.Closable

    org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

    Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor

    org.refcodes.component.ClosedAccessor.ClosedMutator, org.refcodes.component.ClosedAccessor.ClosedProperty

    Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

    org.refcodes.component.ConnectableComponent.ConnectableAutomaton

    Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

    org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

    Nested classes/interfaces inherited from interface org.refcodes.component.Flushable

    org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

    Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

    org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShortTransmitterDecorator(ShortsSource aShortConsumer)
    Instantiates a new short sender decorator.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    void
    flush()
    void
    transmitShort(short aShort)
    Writes (sends) a short.
    void
    transmitShorts(short[] aShorts)
    Writes (sends) a short block.
    void
    transmitShorts(short[] aShorts, int aOffset, int aLength)
    Writes (sends) a short block.

    Methods inherited from class org.refcodes.component.AbstractConnectableAutomaton

    getConnectionStatus, isClosable, isClosed, isOpenable, isOpened, open, setConnectionStatus

    Methods inherited from class org.refcodes.component.AbstractConnectable

    isThrownAsOfAlreadyClosed

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.refcodes.component.Closable

    closeIn, closeQuietly, closeUnchecked

    Methods inherited from interface org.refcodes.component.Closable.CloseAutomaton

    isClosable

    Methods inherited from interface org.refcodes.component.ClosedAccessor

    isClosed

    Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

    getConnectionStatus, isOpened

    Methods inherited from interface org.refcodes.component.Flushable

    flushUnchecked, isFlushable

  • Constructor Details

    • ShortTransmitterDecorator

      public ShortTransmitterDecorator(ShortsSource aShortConsumer)
      Instantiates a new short sender decorator.
      Parameters:
      aShortConsumer - the short consumer

  • Method Details

    • transmitShort

      public void transmitShort(short aShort) throws IOException
      Writes (sends) a short.
      Parameters:
      aShort - The short to be pushed.
      Throws:
      IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

    • transmitShorts

      public void transmitShorts(short[] aShorts) throws IOException
      Writes (sends) a short block.
      Parameters:
      aShorts - The short to be pushed.
      Throws:
      IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

    • transmitShorts

      public void transmitShorts(short[] aShorts, int aOffset, int aLength) throws IOException
      Writes (sends) a short block.
      Parameters:
      aShorts - The short to be pushed.
      aOffset - The offset from which to take the data.
      aLength - The number of elements to push starting at the given offset.
      Throws:
      IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

    • flush

      public void flush() throws IOException
      Throws:
      IOException

    • close

      public void close() throws IOException
      Specified by:
      close in interface org.refcodes.component.Closable
      Overrides:
      close in class org.refcodes.component.AbstractConnectableAutomaton
      Throws:
      IOException