FileStreamContainer

Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.StreamContainer

public final class FileStreamContainer extends StreamContainer

Helper for file stream processing.

Fields

Field	Description
READ_WRITE_BYTES_COUNT	Specifies read and write bytes count when reading sequentially.

Methods

Method	Description
canRead()	Gets a value indicating whether stream supports reading.
canSeek()	Gets a value indicating whether stream supports seeking.
canWrite()	Gets a value indicating whether stream supports writing.
close()	Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7.
createFileStream(String fileLocation, boolean isTemporal)	Creates a new file stream.
create_internalized(System.IO.Stream stream, long startPosition, boolean disposeStream)
dispose()	Disposes the current instance.
equals(Object arg0)
flush()	Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
getClass()
getDisposed()	Gets a value indicating whether this instance is disposed.
getFilePath()	Gets the file path.
getLength()	Gets or sets the stream length in bytes.
getPosition()	Gets or sets the current position within the stream.
getStream()	Gets the data stream.
getStream_internalized()
getSyncRoot()	Gets an object that can be used to synchronize access to the synchronized resource.
hashCode()
isCreated()	Gets a value indicating whether stream was created explicitly.
isStreamDisposedOnClose()	Gets a value indicating whether this stream is disposed on close.
isTemporal()	Gets or sets a value indicating whether stream is temporal.
notify()
notifyAll()
openFileStream(String fileLocation)	Opens an existing file stream.
read(byte[] bytes)	Reads bytes to fill the specified bytes buffer.
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.
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.
save(OutputStream destinationStream)	Saves (copies) the stream’s data to the specified stream.
save(OutputStream destinationStream, int bufferSize)	Saves (copies) all the stream’s data to the specified stream.
save(OutputStream destinationStream, int bufferSize, long length)	Saves (copies) the stream’s data to the specified stream.
save(String filePath)	Saves (copies) the stream’s data to the specified stream.
save(String filePath, int bufferSize)	Saves (copies) the stream’s data to the specified stream.
save(String filePath, int bufferSize, long length)	Saves (copies) the stream’s data to the specified stream.
seek(long offset, int origin)	Sets the position within the current stream.
seekBegin()	Sets the stream position to the beginning of the stream.
setLength(long value)	Gets or sets the stream length in bytes.
setPosition(long value)	Gets or sets the current position within the stream.
setTemporal(boolean value)	Gets or sets a value indicating whether stream is temporal.
takeAwayStream_internalized(StreamContainer src)
toBytes()	Converts the stream data to the byte array.
toBytes(long position, long bytesCount)	Converts the stream data to the byte array.
toString()
to_FileStream(FileStreamContainer fileStreamContainer)	Performs an explicit conversion from FileStreamContainer to FileInputStream.
to_FileStream_internalized(FileStreamContainer fileStreamContainer)
to_Stream(FileStreamContainer fileStreamContainer)	Performs an explicit conversion from FileStreamContainer to java.io.InputStream.
to_Stream(StreamContainer streamContainer)	Performs an explicit conversion from com.aspose.imaging.StreamContainer to System.IO.Stream .
to_Stream_internalized(FileStreamContainer fileStreamContainer)
wait()
wait(long arg0)
wait(long arg0, int arg1)
write(byte[] bytes)	Writes all of the specified bytes to the stream.
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.
writeByte(byte value)	Writes a byte to the current position in the stream and advances the position within the stream by one byte.
writeTo(StreamContainer streamContainer)	Copies the contained data to another StreamContainer .
writeTo(StreamContainer streamContainer, long length)	Copies the contained data to another StreamContainer .

READ_WRITE_BYTES_COUNT

public static final int READ_WRITE_BYTES_COUNT

Specifies read and write bytes count when reading sequentially.

canRead()

public boolean canRead()

Gets a value indicating whether stream supports reading.

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

Returns: boolean

canSeek()

public boolean canSeek()

Gets a value indicating whether stream supports seeking.

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

Returns: boolean

canWrite()

public boolean canWrite()

Gets a value indicating whether stream supports writing.

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

Returns: boolean

close()

public void close()

Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. This method simply call dispose method.

createFileStream(String fileLocation, boolean isTemporal)

public static FileStreamContainer createFileStream(String fileLocation, boolean isTemporal)

Creates a new file stream.

Parameters:

Parameter	Type	Description
fileLocation	java.lang.String	The file location.
isTemporal	boolean	If set to true the file stream container is temporal.

Returns: FileStreamContainer - The file stream container.

create_internalized(System.IO.Stream stream, long startPosition, boolean disposeStream)

public static StreamContainer create_internalized(System.IO.Stream stream, long startPosition, boolean disposeStream)

Parameters:

Parameter	Type	Description
stream	com.aspose.ms.System.IO.Stream
startPosition	long
disposeStream	boolean

Returns: StreamContainer

dispose()

public final void dispose()

Disposes the current instance.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

flush()

public void flush()

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

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getDisposed()

public final boolean getDisposed()

Gets a value indicating whether this instance is disposed.

Returns: boolean - true if disposed; otherwise, false .

getFilePath()

public final String getFilePath()

Gets the file path.

Value: The file path.

Returns: java.lang.String

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.

Returns: long

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.

Returns: long

getStream()

public InputStream getStream()

Gets the data stream.

Value: The data stream.

Returns: java.io.InputStream

getStream_internalized()

public System.IO.Stream getStream_internalized()

Returns: com.aspose.ms.System.IO.Stream

getSyncRoot()

public Object getSyncRoot()

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

Value: The object that can be used to synchronize access to the synchronized resource.

Returns: java.lang.Object

hashCode()

public native int hashCode()

Returns: int

isCreated()

public final boolean isCreated()

Gets a value indicating whether stream was created explicitly.

Value: true if stream was created explicitly; otherwise, false .

Returns: boolean

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 .

Returns: boolean

isTemporal()

public final boolean isTemporal()

Gets or sets a value indicating whether stream is temporal.

Value: true if stream is temporal; otherwise, false .

---

A temporal stream will remove iself when disposed. If the stream is memory based this property has no effect. The stream can be marked as temporal or persistent in case it was created explicitly otherwise the appropriate exception is thrown.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

openFileStream(String fileLocation)

public static FileStreamContainer openFileStream(String fileLocation)

Opens an existing file stream. If file stream does not exist the appropriate exception is thrown.

Parameters:

Parameter	Type	Description
fileLocation	java.lang.String	The file location.

Returns: FileStreamContainer - The file stream container.

read(byte[] bytes)

public int read(byte[] bytes)

Reads bytes to fill the specified bytes buffer.

Parameters:

Parameter	Type	Description
bytes	byte[]	The bytes to fill.

Returns: int - 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.

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

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:

Parameter	Type	Description
buffer	byte[]	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	int	The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count	int	The maximum number of bytes to be read from the current stream.

Returns: int - 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: int - The unsigned byte cast to an Int32, or -1 if at the end of the stream.

save(OutputStream destinationStream)

public void save(OutputStream destinationStream)

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

Parameters:

Parameter	Type	Description
destinationStream	java.io.OutputStream	The stream to save the data to.

save(OutputStream destinationStream, int bufferSize)

public void save(OutputStream destinationStream, int bufferSize)

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

Parameters:

Parameter	Type	Description
destinationStream	java.io.OutputStream	The stream to save the data to.
bufferSize	int	The buffer.

save(OutputStream destinationStream, int bufferSize, long length)

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

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

Parameters:

Parameter	Type	Description
destinationStream	java.io.OutputStream	The stream to save the data to.
bufferSize	int	The buffer size. By default ReadWriteBytesCount value is used.
length	long	The stream data length to copy. By default the length is set to Length value.

save(String filePath)

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:

Parameter	Type	Description
filePath	java.lang.String	The file path to save the stream data to.

save(String filePath, int bufferSize)

public void save(String filePath, int bufferSize)

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

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to save the stream data to.
bufferSize	int	The buffer size. By default ReadWriteBytesCount value is used.

save(String filePath, int bufferSize, long length)

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

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

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file path to save the stream data to.
bufferSize	int	The buffer size. By default ReadWriteBytesCount value is used.
length	long	The stream data length to copy. By default the length is set to Length value.

seek(long offset, int origin)

public long seek(long offset, int origin)

Sets the position within the current stream.

Parameters:

Parameter	Type	Description
offset	long	A byte offset relative to the origin parameter. This value represents offset from the starting stream position passed in the StreamContainer constructor.
origin	int	A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.

Returns: long - 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.

setLength(long value)

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.

Parameters:

Parameter	Type	Description
value	long

setPosition(long value)

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.

Parameters:

Parameter	Type	Description
value	long

setTemporal(boolean value)

public final void setTemporal(boolean value)

Gets or sets a value indicating whether stream is temporal.

Value: true if stream is temporal; otherwise, false .

---

A temporal stream will remove iself when disposed. If the stream is memory based this property has no effect. The stream can be marked as temporal or persistent in case it was created explicitly otherwise the appropriate exception is thrown.

Parameters:

Parameter	Type	Description
value	boolean

takeAwayStream_internalized(StreamContainer src)

public static StreamContainer takeAwayStream_internalized(StreamContainer src)

Parameters:

Parameter	Type	Description
src	StreamContainer

Returns: StreamContainer

toBytes()

public byte[] toBytes()

Converts the stream data to the byte array.

Returns: byte[] - The stream data converted to the byte array.

toBytes(long position, long bytesCount)

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

Converts the stream data to the byte array.

Parameters:

Parameter	Type	Description
position	long	The position to start reading bytes from.
bytesCount	long	The bytes count to read.

Returns: byte[] - The stream data converted to the byte array.

toString()

public String toString()

Returns: java.lang.String

to_FileStream(FileStreamContainer fileStreamContainer)

public static FileInputStream to_FileStream(FileStreamContainer fileStreamContainer)

Performs an explicit conversion from FileStreamContainer to FileInputStream.

Parameters:

Parameter	Type	Description
fileStreamContainer	FileStreamContainer	The file stream container.

Returns: java.io.FileInputStream - The result of the conversion.

to_FileStream_internalized(FileStreamContainer fileStreamContainer)

public static System.IO.FileStream to_FileStream_internalized(FileStreamContainer fileStreamContainer)

Parameters:

Parameter	Type	Description
fileStreamContainer	FileStreamContainer

Returns: com.aspose.ms.System.IO.FileStream

to_Stream(FileStreamContainer fileStreamContainer)

public static InputStream to_Stream(FileStreamContainer fileStreamContainer)

Performs an explicit conversion from FileStreamContainer to java.io.InputStream.

Parameters:

Parameter	Type	Description
fileStreamContainer	FileStreamContainer	The file stream container.

Returns: java.io.InputStream - The result of the conversion.

to_Stream(StreamContainer streamContainer)

public static System.IO.Stream to_Stream(StreamContainer streamContainer)

Performs an explicit conversion from com.aspose.imaging.StreamContainer to System.IO.Stream .

Parameters:

Parameter	Type	Description
streamContainer	StreamContainer	The stream container.

Returns: com.aspose.ms.System.IO.Stream - The result of the conversion.

to_Stream_internalized(FileStreamContainer fileStreamContainer)

public static System.IO.Stream to_Stream_internalized(FileStreamContainer fileStreamContainer)

Parameters:

Parameter	Type	Description
fileStreamContainer	FileStreamContainer

Returns: com.aspose.ms.System.IO.Stream

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int

write(byte[] bytes)

public void write(byte[] bytes)

Writes all of the specified bytes to the stream.

Parameters:

Parameter	Type	Description
bytes	byte[]	The bytes to write.

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

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:

Parameter	Type	Description
buffer	byte[]	An array of bytes. This method copies count bytes from buffer to the current stream.
offset	int	The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count	int	The number of bytes to be written to the current stream.

writeByte(byte value)

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:

Parameter	Type	Description
value	byte	The byte to write to the stream.

writeTo(StreamContainer streamContainer)

public void writeTo(StreamContainer streamContainer)

Copies the contained data to another StreamContainer .

Parameters:

Parameter	Type	Description
streamContainer	StreamContainer	The stream container to copy to.

writeTo(StreamContainer streamContainer, long length)

public void writeTo(StreamContainer streamContainer, long length)

Copies the contained data to another StreamContainer .

Parameters:

Parameter	Type	Description
streamContainer	StreamContainer	The stream container to copy to.
length	long	The bytes count to write.