Package org.refcodes.io

Class OutputStreamSenderImpl<DATA extends java.io.Serializable>

  • Type Parameters:
    DATA - the generic type
    All Implemented Interfaces:
    java.io.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, BlockConsumer<DATA>, BlockSender<DATA>, Consumer<DATA>, DatagramConsumer<DATA>, DatagramSender<DATA>, Sendable, Sender<DATA>

    public class OutputStreamSenderImpl<DATA extends java.io.Serializable>
extends java.lang.Object
implements Sender<DATA>
    The Class OutputStreamSenderImpl.
    Author:
    steiner

    • 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
      OutputStreamSenderImpl​(java.io.OutputStream aOutputStream)
      Instantiates a new output stream sender impl.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close​()
      void flush​()
      org.refcodes.component.ConnectionStatus getConnectionStatus​()
      boolean isClosable​()
      boolean isClosed​()
      boolean isOpened​()
      void writeDatagram​(DATA aDatagram)
      Writes (sends) a datagram to a listening DatagramReceiver.
      void writeDatagrams​(DATA[] aDatagram)
      Writes (sends) a datagram block to a listening DatagramReceiver or BlockReceiver.
      void writeDatagrams​(DATA[] aDatagram, int aOffset, int aLength)
      Write datagrams.

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

        closeIn, closeQuietly, closeUnchecked

      • Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

        isConnectionOpened

      • Methods inherited from interface org.refcodes.component.Flushable

        flushUnchecked, isFlushable

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • OutputStreamSenderImpl

        public OutputStreamSenderImpl​(java.io.OutputStream aOutputStream)
                       throws org.refcodes.component.OpenException
        Instantiates a new output stream sender impl.
        Parameters:
        aOutputStream - the output stream
        Throws:
        org.refcodes.component.OpenException - the open exception

    • Method Detail

      • writeDatagrams

        public void writeDatagrams​(DATA[] aDatagram)
                    throws org.refcodes.component.OpenException
        Writes (sends) a datagram block to a listening DatagramReceiver or BlockReceiver.
        Specified by:
        writeDatagrams in interface BlockConsumer<DATA extends java.io.Serializable>
        Specified by:
        writeDatagrams in interface Consumer<DATA extends java.io.Serializable>
        Parameters:
        aDatagram - The datagram to be pushed to the receiving DatagramReceiver or BlockReceiver.
        Throws:
        org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

      • isClosed

        public boolean isClosed​()
        Specified by:
        isClosed in interface org.refcodes.component.ClosedAccessor

      • isOpened

        public boolean isOpened​()
        Specified by:
        isOpened in interface org.refcodes.component.OpenedAccessor

      • getConnectionStatus

        public org.refcodes.component.ConnectionStatus getConnectionStatus​()
        Specified by:
        getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

      • writeDatagrams

        public void writeDatagrams​(DATA[] aDatagram,
                           int aOffset,
                           int aLength)
                    throws org.refcodes.component.OpenException
        Write datagrams.
        Specified by:
        writeDatagrams in interface BlockConsumer<DATA extends java.io.Serializable>
        Specified by:
        writeDatagrams in interface Sender<DATA extends java.io.Serializable>
        Parameters:
        aDatagram - the datagram
        aOffset - the offset
        aLength - the length
        Throws:
        org.refcodes.component.OpenException - the open exception

      • close

        public void close​()
           throws org.refcodes.component.CloseException
        Specified by:
        close in interface org.refcodes.component.Closable
        Throws:
        org.refcodes.component.CloseException

      • writeDatagram

        public void writeDatagram​(DATA aDatagram)
                   throws org.refcodes.component.OpenException
        Writes (sends) a datagram to a listening DatagramReceiver.
        Specified by:
        writeDatagram in interface Consumer<DATA extends java.io.Serializable>
        Specified by:
        writeDatagram in interface DatagramConsumer<DATA extends java.io.Serializable>
        Parameters:
        aDatagram - The datagram to be pushed to the receiving DatagramConsumer.
        Throws:
        org.refcodes.component.OpenException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

      • flush

        public void flush​()
           throws org.refcodes.component.OpenException
        Specified by:
        flush in interface java.io.Flushable
        Specified by:
        flush in interface org.refcodes.component.Flushable
        Specified by:
        flush in interface Sender<DATA extends java.io.Serializable>
        Throws:
        org.refcodes.component.OpenException

      • isClosable

        public boolean isClosable​()
        Specified by:
        isClosable in interface org.refcodes.component.Closable.CloseAutomaton