Packages

 

com.aspose.cad

Class StreamContainer

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int READ_WRITE_BYTES_COUNT
      Specifies read and write bytes count when reading sequentially.
    • Constructor Summary

      Constructors 
      Constructor and Description
      StreamContainer(InputStream stream)
      Initializes a new instance of the StreamContainer class.
      StreamContainer(InputStream stream, boolean disposeStream)
      Initializes a new instance of the StreamContainer class.
      StreamContainer(com.aspose.ms.System.IO.Stream stream) 
      StreamContainer(com.aspose.ms.System.IO.Stream stream, boolean disposeStream) 
    • Method Summary

      All Methods Static 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 or sets the stream length in bytes.
      long getPosition()
      Gets or sets the current position within the stream.
      com.aspose.ms.System.IO.Stream getStream_internalized()
      Gets the data stream.
      InputStream getStream() 
      boolean isStreamDisposedOnClose()
      Gets a value indicating whether this stream is disposed on close.
      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.
      void save(OutputStream destinationStream) 
      void save(OutputStream destinationStream, int bufferSize) 
      void save(OutputStream destinationStream, int bufferSize, long length) 
      void save(String filePath)
      Saves (copies) the stream's data to the specified stream.
      void save(String filePath, int bufferSize)
      Saves (copies) the stream's data to the specified stream.
      void save(String filePath, int bufferSize, long length)
      Saves (copies) the stream's data to the specified 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)
      Gets or sets the stream length in bytes.
      void setPosition(long value)
      Gets or sets the current position within the stream.
      static com.aspose.ms.System.IO.Stream to_Stream(StreamContainer streamContainer)
      Performs an explicit conversion from Aspose.Imaging.StreamContainer to System.IO.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.
      void writeTo(StreamContainer streamContainer)
      Copies the contained data to another StreamContainer.
      void writeTo(StreamContainer streamContainer, long length)
      Copies the contained data to another StreamContainer.
    • Field Detail

      • READ_WRITE_BYTES_COUNT

        public static final int READ_WRITE_BYTES_COUNT

        Specifies read and write bytes count when reading sequentially.

        See Also:
        Constant Field Values
    • Constructor Detail

      • StreamContainer

        public StreamContainer(InputStream stream)

        Initializes a new instance of the StreamContainer class.

        Parameters:
        stream - The stream.
      • StreamContainer

        public StreamContainer(com.aspose.ms.System.IO.Stream stream)
      • StreamContainer

        public StreamContainer(InputStream stream,
                               boolean disposeStream)

        Initializes a new instance of the StreamContainer class.

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

        public StreamContainer(com.aspose.ms.System.IO.Stream stream,
                               boolean disposeStream)
    • Method Detail

      • getPosition

        public long getPosition()

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

        Value: The current stream position.
      • setPosition

        public void setPosition(long value)

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

        Value: The current stream position.
      • getStream_internalized

        public com.aspose.ms.System.IO.Stream getStream_internalized()

        Gets the data stream.

        Value: The data stream.
      • isStreamDisposedOnClose

        public boolean isStreamDisposedOnClose()

        Gets a value indicating whether this stream is disposed on close.

        Value: true if stream is disposed on close; otherwise, false.
      • getLength

        public long getLength()

        Gets or 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.

        Value: The stream length.
      • setLength

        public void setLength(long value)

        Gets or 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.

        Value: The stream length.
      • canRead

        public boolean canRead()

        Gets a value indicating whether stream supports reading.

        Value: true if stream supports reading; otherwise, false.
      • canSeek

        public boolean canSeek()

        Gets a value indicating whether stream supports seeking.

        Value: true if stream supports seeking; otherwise, false.
      • canWrite

        public boolean canWrite()

        Gets a value indicating whether stream supports writing.

        Value: true if stream supports writing; otherwise, false.
      • to_Stream

        public static com.aspose.ms.System.IO.Stream to_Stream(StreamContainer streamContainer)

        Performs an explicit conversion from Aspose.Imaging.StreamContainer to System.IO.Stream.

        Parameters:
        streamContainer - The stream container.
        Returns:
        The result of the conversion.
      • flush

        public void flush()

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

      • write

        public void write(byte[] bytes)

        Writes all of the specified bytes to the stream.

        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.

        Parameters:
        value - The byte to write to the stream.
      • read

        public int read(byte[] bytes)

        Reads bytes to fill the specified bytes buffer.

        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.

        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.

        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.

        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.

        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.

        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 T: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.

      • 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.

        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.
      • save

        public void save(OutputStream destinationStream,
                         int bufferSize)
      • save

        public void save(OutputStream destinationStream,
                         int bufferSize,
                         long length)
      • save

        public void save(String filePath)

        Saves (copies) the stream's data to the specified stream. Uses default buffer size ReadWriteBytesCount and stream Length value.

        Parameters:
        filePath - The file path to save the stream data to.
      • save

        public void save(String filePath,
                         int bufferSize)

        Saves (copies) the stream's data to the specified stream. Uses stream Length value.

        Parameters:
        filePath - The file path to save the stream data to.
        bufferSize - The buffer size. By default ReadWriteBytesCount value is used.
      • save

        public void save(String filePath,
                         int bufferSize,
                         long length)

        Saves (copies) the stream's data to the specified stream.

        Parameters:
        filePath - The file path to save the stream data to.
        bufferSize - The buffer size. By default ReadWriteBytesCount value is used.
        length - The stream data length to copy. By default the length is set to Length value.
      • writeTo

        public void writeTo(StreamContainer streamContainer)

        Copies the contained data to another StreamContainer.

        Parameters:
        streamContainer - The stream container to copy to.
      • writeTo

        public void writeTo(StreamContainer streamContainer,
                            long length)

        Copies the contained data to another StreamContainer.

        Parameters:
        streamContainer - The stream container to copy to.
        length - The bytes count to write.
        Throws:
        FrameworkException - Copy operation cannot complete. Cannot read + count + bytes.