Packages

 

com.aspose.imaging

Interfaces

Classes

com.aspose.imaging

Class SplitStreamContainer

  • All Implemented Interfaces:
    com.aspose.imaging_internal.interfaces.ISynchronizable, com.aspose.ms.System.IDisposable, Closeable, AutoCloseable


    public class SplitStreamContainer
    extends StreamContainer

    Represents split stream container which contains the stream and provides stream processing routines.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean canRead()
      Gets a value indicating whether stream supports reading.
      boolean canSeek()
      Gets a value indicating whether stream supports seeking.
      boolean canWrite()
      Gets a value indicating whether stream supports writing.
      void flush()
      Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
      long getLength()
      Gets the stream length in bytes.
      long getPosition()
      Gets the current position within the stream.
      Object getSyncRoot()
      Gets an object that can be used to synchronize access to the synchronized resource.
      void insert(int position, StreamContainer stream, boolean disposeStream)
      Inserts the stream container into specified position.
      int read(byte[] bytes)
      Reads bytes to fill the specified bytes buffer.
      int read(byte[] buffer, int offset, int count)
      Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
      int readByte()
      Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
      long seek(long offset, int origin)
      Sets the position within the current stream.
      void seekBegin()
      Sets the stream position to the beginning of the stream.
      void setLength(long value)
      Sets the stream length in bytes.
      void setPosition(long value)
      Sets the current position within the stream.
      byte[] toBytes()
      Converts the stream data to the byte array.
      byte[] toBytes(long position, long bytesCount)
      Converts the stream data to the byte array.
      void write(byte[] bytes)
      Writes all of the specified bytes to the stream.
      void write(byte[] buffer, int offset, int count)
      Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
      void writeByte(byte value)
      Writes a byte to the current position in the stream and advances the position within the stream by one byte.
    • Constructor Detail

      • SplitStreamContainer

        public SplitStreamContainer(InputStream stream)

        Initializes a new instance of the SplitStreamContainer class.

        Parameters:
        stream - The stream.
      • SplitStreamContainer

        public SplitStreamContainer(InputStream stream,
                                    boolean disposeStream)

        Initializes a new instance of the SplitStreamContainer class.

        Parameters:
        stream - The data stream.
        disposeStream - if set to true the stream will be disposed when container is disposed.
      • SplitStreamContainer

        public SplitStreamContainer(StreamContainer stream,
                                    boolean disposeStream)

        Initializes a new instance of the SplitStreamContainer class.

        Parameters:
        stream - The stream container.
        disposeStream - if set to true disposes stream.
    • Method Detail

      • getSyncRoot

        public Object getSyncRoot()

        Gets an object that can be used to synchronize access to the synchronized resource.

        Specified by:
        getSyncRoot in interface com.aspose.imaging_internal.interfaces.ISynchronizable
        Overrides:
        getSyncRoot in class StreamContainer
        Returns:
        The object that can be used to synchronize access to the synchronized resource.
      • getPosition

        public long getPosition()

        Gets the current position within the stream. This value represents offset from the starting stream position passed in the StreamContainer constructor.

        Overrides:
        getPosition in class StreamContainer
        Returns:
        The current stream position.
      • setPosition

        public void setPosition(long value)

        Sets the current position within the stream. This value represents offset from the starting stream position passed in the StreamContainer constructor.

        Overrides:
        setPosition in class StreamContainer
        Parameters:
        value - The current stream position.
      • getLength

        public long getLength()

        Gets the stream length in bytes. This value is less than the System.IO.Stream.Length by the starting stream position passed in the StreamContainer constructor.

        Overrides:
        getLength in class StreamContainer
        Returns:
        The stream length.
      • setLength

        public void setLength(long value)

        Sets the stream length in bytes. This value is less than the System.IO.Stream.Length by the starting stream position passed in the StreamContainer constructor.

        Overrides:
        setLength in class StreamContainer
        Parameters:
        value - The stream length.
      • canRead

        public boolean canRead()

        Gets a value indicating whether stream supports reading.

        Overrides:
        canRead in class StreamContainer
        Returns:
        true if stream supports reading; otherwise, false.
      • canSeek

        public boolean canSeek()

        Gets a value indicating whether stream supports seeking.

        Overrides:
        canSeek in class StreamContainer
        Returns:
        true if stream supports seeking; otherwise, false.
      • canWrite

        public boolean canWrite()

        Gets a value indicating whether stream supports writing.

        Overrides:
        canWrite in class StreamContainer
        Returns:
        true if stream supports writing; otherwise, false.
      • insert

        public void insert(int position,
                           StreamContainer stream,
                           boolean disposeStream)

        Inserts the stream container into specified position.

        Parameters:
        position - The position to insert to.
        stream - The stream container to insert.
        disposeStream - if set to true disposes stream.
      • flush

        public void flush()

        Clears all buffers for this stream and causes any buffered data to be written to the underlying device.

        Overrides:
        flush in class StreamContainer
      • write

        public void write(byte[] bytes)

        Writes all of the specified bytes to the stream.

        Overrides:
        write in class StreamContainer
        Parameters:
        bytes - The bytes to write.
      • writeByte

        public void writeByte(byte value)

        Writes a byte to the current position in the stream and advances the position within the stream by one byte.

        Overrides:
        writeByte in class StreamContainer
        Parameters:
        value - The byte to write to the stream.
      • read

        public int read(byte[] bytes)

        Reads bytes to fill the specified bytes buffer.

        Overrides:
        read in class StreamContainer
        Parameters:
        bytes - The bytes to fill.
        Returns:
        The number of bytes read. This value can be less than the number of bytes in the buffer if there is not enough bytes in the stream.
      • toBytes

        public byte[] toBytes()

        Converts the stream data to the byte array.

        Overrides:
        toBytes in class StreamContainer
        Returns:
        The stream data converted to the byte array.
      • toBytes

        public byte[] toBytes(long position,
                              long bytesCount)

        Converts the stream data to the byte array.

        Overrides:
        toBytes in class StreamContainer
        Parameters:
        position - The position to start reading bytes from.
        bytesCount - The bytes count to read.
        Returns:
        The stream data converted to the byte array.
      • read

        public int read(byte[] buffer,
                        int offset,
                        int count)

        Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

        Overrides:
        read in class StreamContainer
        Parameters:
        buffer - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
        offset - The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
        count - The maximum number of bytes to be read from the current stream.
        Returns:
        The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
      • readByte

        public int readByte()

        Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.

        Overrides:
        readByte in class StreamContainer
        Returns:
        The unsigned byte cast to an Int32, or -1 if at the end of the stream.
      • seek

        public long seek(long offset,
                         int origin)

        Sets the position within the current stream.

        Overrides:
        seek in class StreamContainer
        Parameters:
        offset - A byte offset relative to the origin parameter. This value represents offset from the starting stream position passed in the StreamContainer constructor.
        origin - A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
        Returns:
        The new position within the current stream.
      • seekBegin

        public void seekBegin()

        Sets the stream position to the beginning of the stream. This value represents offset from the starting stream position passed in the StreamContainer constructor.

        Overrides:
        seekBegin in class StreamContainer
      • write

        public void write(byte[] buffer,
                          int offset,
                          int count)

        Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

        Overrides:
        write in class StreamContainer
        Parameters:
        buffer - An array of bytes. This method copies count bytes from buffer to the current stream.
        offset - The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
        count - The number of bytes to be written to the current stream.