Package org.apache.abdera.i18n.text.io

Class PipeChannel

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.Appendable, java.lang.AutoCloseable, java.lang.Readable, java.nio.channels.Channel, java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel
    public class PipeChannel
extends java.lang.Object
implements java.nio.channels.ReadableByteChannel, java.nio.channels.WritableByteChannel, java.lang.Appendable, java.lang.Readable, java.io.Closeable
    Implements a buffer that provides a slightly more efficient way of writing, and then reading a stream of bytes. To use: PipeChannel pipe = new PipeChannel(); byte[] bytes = {'a','b','c','d'}; pipe.write(bytes); pipe.close(); InputStream in = pipe.getInputStream(); int i = -1; while ((i = in.read()) != -1) {...} By default, closing will automatically cause it to flip over to Read mode, locking the buffer from further writes and setting the read position to 0. Once the Buffer has been fully read, it must be reset, which sets it back into write mode

    • Constructor Summary

      Constructors 
      Constructor Description
      PipeChannel()  
      PipeChannel​(java.lang.String charset)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Appendable append​(char c)  
      java.lang.Appendable append​(char c, java.lang.String charset)  
      java.lang.Appendable append​(java.lang.CharSequence csq)  
      java.lang.Appendable append​(java.lang.CharSequence csq, int start, int end)  
      java.lang.Appendable append​(java.lang.CharSequence csq, int start, int end, java.lang.String charset)  
      java.lang.Appendable append​(java.lang.CharSequence csq, java.lang.String charset)  
      void close()
      If the pipe is writable, this will close the input and switch to readable mode If the pipe is readable, this will close the output and reset the pipe
      java.io.InputStream getInputStream()
      Get an inputstream that can read from this pipe.
      CodepointIterator getIterator()
      Get a CodepointIterator that can iterate over unicode codepoints in this pipe.
      CodepointIterator getIterator​(java.lang.String charset)
      Get a CodepointIterator that can iterate over unicode codepoints in this pipe.
      java.io.OutputStream getOutputStream()
      Get an outputstream that can write to this pipe.
      java.io.Reader getReader()
      Get a reader that can reader from this pipe.
      java.io.Reader getReader​(java.lang.String charset)
      Get a reader that can reader from this pipe.
      java.io.Writer getWriter()
      Get a writer that can write to this pipe.
      java.io.Writer getWriter​(java.lang.String charset)
      Get a writer that can write to this pipe.
      boolean isOpen()
      True if the pipe is open
      boolean isReadable()
      True if this pipe is readable
      boolean isWritable()
      True if this pipe is writable
      int read​(byte[] dst)
      Read from the pipe.
      int read​(byte[] dst, int offset, int length)
      Read from the pipe.
      int read​(java.nio.ByteBuffer dst)
      Read from the pipe.
      int read​(java.nio.CharBuffer cb)  
      int read​(java.nio.CharBuffer cb, java.lang.String charset)  
      void reset()
      Reset the pipe.
      int write​(byte[] src)
      Write to the pipe
      int write​(byte[] src, int offset, int len)
      Write to the pipe
      int write​(java.nio.ByteBuffer src)
      Write to the pipe

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PipeChannel

        public PipeChannel()

      • PipeChannel

        public PipeChannel​(java.lang.String charset)

    • Method Detail

      • getInputStream

        public java.io.InputStream getInputStream()
        Get an inputstream that can read from this pipe. The Pipe must be readable

      • getOutputStream

        public java.io.OutputStream getOutputStream()
        Get an outputstream that can write to this pipe. The Pipe must be writable

      • getWriter

        public java.io.Writer getWriter()
        Get a writer that can write to this pipe. The pipe must be writable

      • getWriter

        public java.io.Writer getWriter​(java.lang.String charset)
        Get a writer that can write to this pipe. The pipe must be writable

      • getReader

        public java.io.Reader getReader​(java.lang.String charset)
        Get a reader that can reader from this pipe. The pipe must be readable

      • getReader

        public java.io.Reader getReader()
        Get a reader that can reader from this pipe. The pipe must be readable

      • getIterator

        public CodepointIterator getIterator()
        Get a CodepointIterator that can iterate over unicode codepoints in this pipe. The pipe must be readable

      • getIterator

        public CodepointIterator getIterator​(java.lang.String charset)
        Get a CodepointIterator that can iterate over unicode codepoints in this pipe. The pipe must be readable

      • read

        public int read​(java.nio.ByteBuffer dst)
         throws java.io.IOException
        Read from the pipe.
        Specified by:
        read in interface java.nio.channels.ReadableByteChannel
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] dst)
         throws java.io.IOException
        Read from the pipe.
        Throws:
        java.io.IOException

      • read

        public int read​(byte[] dst,
                int offset,
                int length)
         throws java.io.IOException
        Read from the pipe.
        Throws:
        java.io.IOException

      • isOpen

        public boolean isOpen()
        True if the pipe is open
        Specified by:
        isOpen in interface java.nio.channels.Channel

      • write

        public int write​(java.nio.ByteBuffer src)
          throws java.io.IOException
        Write to the pipe
        Specified by:
        write in interface java.nio.channels.WritableByteChannel
        Throws:
        java.io.IOException

      • write

        public int write​(byte[] src)
          throws java.io.IOException
        Write to the pipe
        Throws:
        java.io.IOException

      • write

        public int write​(byte[] src,
                 int offset,
                 int len)
          throws java.io.IOException
        Write to the pipe
        Throws:
        java.io.IOException

      • isReadable

        public boolean isReadable()
        True if this pipe is readable

      • isWritable

        public boolean isWritable()
        True if this pipe is writable

      • close

        public void close()
           throws java.io.IOException
        If the pipe is writable, this will close the input and switch to readable mode If the pipe is readable, this will close the output and reset the pipe
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.nio.channels.Channel
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException

      • reset

        public void reset()
        Reset the pipe. Switches the pipe to writable mode

      • append

        public java.lang.Appendable append​(java.lang.CharSequence csq)
                            throws java.io.IOException
        Specified by:
        append in interface java.lang.Appendable
        Throws:
        java.io.IOException

      • append

        public java.lang.Appendable append​(char c)
                            throws java.io.IOException
        Specified by:
        append in interface java.lang.Appendable
        Throws:
        java.io.IOException

      • append

        public java.lang.Appendable append​(java.lang.CharSequence csq,
                                   int start,
                                   int end)
                            throws java.io.IOException
        Specified by:
        append in interface java.lang.Appendable
        Throws:
        java.io.IOException

      • append

        public java.lang.Appendable append​(java.lang.CharSequence csq,
                                   java.lang.String charset)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • append

        public java.lang.Appendable append​(char c,
                                   java.lang.String charset)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • append

        public java.lang.Appendable append​(java.lang.CharSequence csq,
                                   int start,
                                   int end,
                                   java.lang.String charset)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • read

        public int read​(java.nio.CharBuffer cb)
         throws java.io.IOException
        Specified by:
        read in interface java.lang.Readable
        Throws:
        java.io.IOException

      • read

        public int read​(java.nio.CharBuffer cb,
                java.lang.String charset)
         throws java.io.IOException
        Throws:
        java.io.IOException