Package com.adobe.internal.io

Class FilterByteWriter

java.lang.Object
com.adobe.internal.io.FilterByteWriter
All Implemented Interfaces:
ByteReader, ByteWriter
Direct Known Subclasses:
RangedByteWriter
public abstract class FilterByteWriter extends Object implements ByteWriter
Filters wrap existing ByteWriters and will do conversion or other data mangling.

  • Field Summary

    Fields inherited from interface com.adobe.internal.io.ByteReader

    EOF

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Closes this ByteReader and releases any system resources associated with this stream.
    void
    flush()
    Flushes this ByteWriter and forces any unwritten buffered output bytes to be written out to the underlying repository.
    long
    length()
    Returns the number of total bytes in the repository that are visible through this API.
    int
    read(long position)
    Read a single byte from the underlying bytes at the given position.
    int
    read(long position, byte[] b, int offset, int length)
    Transfers bytes from the underlying repository into the given destination array.
    void
    setCloseOriginal(boolean closeOriginal)
    Changes whether the original ByteWriter is closed when this FilterByteWriter is closed.
    void
    write(long position, byte[] b, int offset, int length)
    Write an array of bytes at the position given.
    void
    write(long position, int b)
    Write the byte given at the position given.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • setCloseOriginal

      public void setCloseOriginal(boolean closeOriginal)
      Changes whether the original ByteWriter is closed when this FilterByteWriter is closed. By default this is true.
      Parameters:
      closeOriginal - close original ByteWriter or not

    • flush

      public void flush() throws IOException
      Description copied from interface: ByteWriter
      Flushes this ByteWriter and forces any unwritten buffered output bytes to be written out to the underlying repository.
      Specified by:
      flush in interface ByteWriter
      Throws:
      IOException - if an error occurs while trying to flush the buffer

    • write

      public void write(long position, int b) throws IOException
      Description copied from interface: ByteWriter
      Write the byte given at the position given. If during the write operation the byte to be written is beyond the end of the virtual array visible through this interface then the length of that virtual array becomes the position of the byte written plus one (because of zero based counting). length of virtual array = max(length of virtual array, position of byte written + 1)
      Specified by:
      write in interface ByteWriter
      Parameters:
      position - the zero-based offset within the byte array.
      b - the byte to write.
      Throws:
      IOException - if an error occurs during the write operation

    • write

      public void write(long position, byte[] b, int offset, int length) throws IOException
      Description copied from interface: ByteWriter
      Write an array of bytes at the position given. If during the write operation any of the bytes are to be written beyond the end of the virtual array visible through this interface then the length of that virtual array becomes the position of the byte written plus one (because of zero based counting). for each byte written : length of virtual array = max(length of virtual array, position of byte written + 1)
      Specified by:
      write in interface ByteWriter
      Parameters:
      position - the zero-based offset within the byte array.
      b - the array of bytes to write from.
      offset - the offset within the byte array to start writing from.
      length - the number of bytes to write from the byte array.
      Throws:
      IOException - if an error occurs during the write operation

    • close

      public void close() throws IOException
      Description copied from interface: ByteReader
      Closes this ByteReader and releases any system resources associated with this stream.
      Specified by:
      close in interface ByteReader
      Throws:
      IOException - if an error occurs while trying to close

    • length

      public long length() throws IOException
      Description copied from interface: ByteReader
      Returns the number of total bytes in the repository that are visible through this API.
      Specified by:
      length in interface ByteReader
      Returns:
      the number of bytes in the repository.
      Throws:
      IOException - if an error occurs while trying to determine the length

    • read

      public int read(long position) throws IOException
      Description copied from interface: ByteReader
      Read a single byte from the underlying bytes at the given position.
      Specified by:
      read in interface ByteReader
      Parameters:
      position - the position to read the byte from.
      Returns:
      the byte at the postion or EOF if the position is outside of the legal range.
      Throws:
      IOException - if an error occurs during the read operation

    • read

      public int read(long position, byte[] b, int offset, int length) throws IOException
      Description copied from interface: ByteReader
      Transfers bytes from the underlying repository into the given destination array. Copy up to length bytes from the repository starting at the postion given into the given array starting at the given offset.
      Specified by:
      read in interface ByteReader
      Parameters:
      position - the position to read the byte from.
      b - the array to write the bytes into.
      offset - the offset in the array at which the first byte is written.
      length - the maximum number of bytes to write into the array.
      Returns:
      the number of bytes actually written to the array.
      Throws:
      IOException - if an error occurs during the read operation