aspose.pdf
Class BinaryFileStream

java.lang.Object
  aspose.pdf.BasicStream
      aspose.pdf.BinaryFileStream

public class BinaryFileStream
extends BasicStream

Stream represent binary code .

Field Summary

Fields inherited from class aspose.pdf.BasicStream

canRead, canSeek, canWrite, length, seek

Constructor Summary

BinaryFileStream()
Constructs a BinaryFileStream instance.

BinaryFileStream(BinaryFileStream bfs)
Constructs a BinaryFileStream instance from another BinaryFileStream.

BinaryFileStream(byte[] arr)
Constructs a BinaryFileStream instance from a byte array.

BinaryFileStream(java.io.File infile)
construct a BinaryFileStream instance from a File object.

BinaryFileStream(java.io.File infile, boolean canwrite)
Constructs a BinaryFileStream instance from a File object.

BinaryFileStream(java.io.FileInputStream infs)
Constructs a BinaryFileStream instance from a FileInputStream object.

BinaryFileStream(java.io.FileInputStream infs, boolean canwrite)
construct a BinaryFileStream instance from a FileInputStream object.

BinaryFileStream(java.lang.String infile)
Constructs a BinaryFileStream instance from a file.

BinaryFileStream(java.lang.String infile, boolean canwrite)
Construct a BinaryFileStream instance from a file.

Method Summary

void	close() Closes the stream.
void	flush() Flushes the stream.
java.io.FileInputStream	getInput() Gets the FileInputStream object.
int	read() Reads an int value.
int	read(byte[] data) Reads a byte array into the stream.
int	read(byte[] data, int offset, int count) Reads a byte array from the stream.
int	read(int[] data) Reads a int array from the stream.
int	read(int[] data, int offset, int count) Reads a int array from the stream.
byte	readByte() Reads a byte from the stream.
byte[]	readBytes(long getlength) Reads content into a byte array.
void	setappendwrite(boolean value) Sets appending write mode.
void	setInput(java.io.FileInputStream fs) Sets the FileInputStream object.
void	setoutput(java.io.File outfile) Sets output.
void	setoutput(java.lang.String outfile) Sets output.
void	setPosition(int pos) Set the pointer position.
void	setSeek(long value) Sets the offset .
void	setSeek(long orig, long offset) Sets the offset compare to origin.
void	skip(long number) Skips several bytes.
byte[]	toArray() Converts to a byte array.
int[]	toIntArray() Converts to a int array.
MemStream	toMemStream() Transfers the stream to a Memory Stream.
void	write() Writes a char to the output stream
void	write(BinaryFileStream bfs) Writes the content to a BinaryFileStream object.
void	write(byte data) Writes a byte value to the output stream.
void	write(byte[] data) Writes a byte array to the output stream.
void	write(byte[] data, int offset, int count) Writes a byte array to the output stream.

Methods inherited from class aspose.pdf.BasicStream

getCanRead, getCanSeek, getCanWrite, getLength, getSeek, setCanRead, setCanSeek, setCanWrite, setLength

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFileStream

public BinaryFileStream()

Constructs a BinaryFileStream instance.

BinaryFileStream

public BinaryFileStream(byte[] arr)

Constructs a BinaryFileStream instance from a byte array.

Parameters:

arr - The byte array.

BinaryFileStream

public BinaryFileStream(java.lang.String infile)

Constructs a BinaryFileStream instance from a file.

Parameters:

infile - The file name.

BinaryFileStream

public BinaryFileStream(java.lang.String infile,
                        boolean canwrite)

Construct a BinaryFileStream instance from a file.

Parameters:

infile - The file name.

canwrite - Whether the stream can write.

BinaryFileStream

public BinaryFileStream(BinaryFileStream bfs)

Constructs a BinaryFileStream instance from another BinaryFileStream.

Parameters:

bfs - The BinaryFileStream.

BinaryFileStream

public BinaryFileStream(java.io.File infile)

construct a BinaryFileStream instance from a File object.

Parameters:

infile - The File object.

BinaryFileStream

public BinaryFileStream(java.io.File infile,
                        boolean canwrite)

Constructs a BinaryFileStream instance from a File object.

Parameters:

infile - The File object.

canwrite - Whether the stream can write.

BinaryFileStream

public BinaryFileStream(java.io.FileInputStream infs)

Constructs a BinaryFileStream instance from a FileInputStream object.

Parameters:

infs - The FileInputStream object.

BinaryFileStream

public BinaryFileStream(java.io.FileInputStream infs,
                        boolean canwrite)

construct a BinaryFileStream instance from a FileInputStream object.

Parameters:

infs - The FileInputStream object.

canwrite - Whether the stream can write.

Method Detail

getInput

public java.io.FileInputStream getInput()

Gets the FileInputStream object.

Returns:

the FileInputStream object.

setInput

public void setInput(java.io.FileInputStream fs)

Sets the FileInputStream object.

Parameters:

fs - The FileInputStream object.

setSeek

public void setSeek(long value)

Sets the offset .

Overrides:

setSeek in class BasicStream

Parameters:

value - The offset value.

setSeek

public void setSeek(long orig,
                    long offset)

Sets the offset compare to origin.

Overrides:

setSeek in class BasicStream

Parameters:

orig - The original position.

offset - The offset.

setappendwrite

public void setappendwrite(boolean value)

Sets appending write mode.

Parameters:

value - A boolean value that indicates whether the stream is appending write mode.

setoutput

public void setoutput(java.lang.String outfile)

Sets output.

Parameters:

outfile - The output file name.

setoutput

public void setoutput(java.io.File outfile)

Sets output.

Parameters:

outfile - The output File object.

read

public int read()

Reads an int value.

Overrides:

read in class BasicStream

Returns:

An int value.

readByte

public byte readByte()

Reads a byte from the stream.

Overrides:

readByte in class BasicStream

Returns:

A byte value.

toArray

public byte[] toArray()

Converts to a byte array.

Returns:

The byte array.

toIntArray

public int[] toIntArray()

Converts to a int array.

Returns:

A int array.

read

public int read(byte[] data)

Reads a byte array into the stream.

Parameters:

data - The byte array.

Returns:

The count of the byte values that reads.

read

public int read(int[] data)

Reads a int array from the stream.

Parameters:

data - The int array.

Returns:

The count of the int values that reads.

read

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

Reads a byte array from the stream.

Overrides:

read in class BasicStream

Parameters:

data - The byte array.

offset - The stream offset.

count - The count of the byte value that will be read.

Returns:

The real count of the byte value that reads from the stream.

read

public int read(int[] data,
                int offset,
                int count)

Reads a int array from the stream.

Parameters:

data - The int array.

offset - The stream offset.

count - The count of the int value that will be read.

Returns:

The real count of the int value that reads from the stream.

skip

public void skip(long number)

Skips several bytes.

Overrides:

skip in class BasicStream

Parameters:

number - The number of the bytes.

write

public void write()

Writes a char to the output stream

Overrides:

write in class BasicStream

write

public void write(BinaryFileStream bfs)

Writes the content to a BinaryFileStream object.

Parameters:

bfs - The BinaryFileStream object.

write

public void write(byte data)

Writes a byte value to the output stream.

Overrides:

write in class BasicStream

Parameters:

data - The byte value.

write

public void write(byte[] data)

Writes a byte array to the output stream.

Overrides:

write in class BasicStream

Parameters:

data - The byte array.

write

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

Writes a byte array to the output stream.

Overrides:

write in class BasicStream

Parameters:

data - The byte array.

offset - The stream offset.

count - The count of the byte values that needs to be read.

flush

public void flush()

Flushes the stream.

Overrides:

flush in class BasicStream

close

public void close()

Closes the stream.

Overrides:

close in class BasicStream

setPosition

public void setPosition(int pos)

Set the pointer position.

Parameters:

pos - The position of the pointer.

readBytes

public byte[] readBytes(long getlength)

Reads content into a byte array.

Parameters:

getlength - The length of the content.

Returns:

The byte array.

toMemStream

public MemStream toMemStream()
                      throws java.io.IOException

Transfers the stream to a Memory Stream.

Returns:

The MemStream object.

Throws:

java.io.IOException