net.bitform.api

Class NativeSimpleChannel

java.lang.Object

net.bitform.api.NativeSimpleChannel

All Implemented Interfaces:

SimpleChannel

public class NativeSimpleChannel
extends java.lang.Object
implements SimpleChannel

Class used to integrate the Java API with C++. Developer may ignore.

Field Summary

Fields

Modifier and Type	Field and Description
long	nativeChannel

Fields inherited from interface net.bitform.api.SimpleChannel

DIRECTBYTEBUFFERS, READ, READWRITE, WRITE

Constructor Summary

Constructors

Constructor and Description
NativeSimpleChannel(long n)

Method Summary

Modifier and Type	Method and Description
void	close() Close resources associated with this SimpleChannel
int	read(java.nio.ByteBuffer buffer, long position) Read bytes into the buffer from the developer's bytes.
long	size() The size of the developer's bytes.
int	supports() Return what operations the SimpleChannel supports
void	truncate(long size) Truncate the stream to the given length.
void	write(java.nio.ByteBuffer buffer, long position) Writes bytes from the buffer to the developer's bytes.

Methods inherited from class java.lang.Object

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

Field Detail

nativeChannel

public final long nativeChannel

Constructor Detail

NativeSimpleChannel

public NativeSimpleChannel(long n)

Method Detail

read

public int read(java.nio.ByteBuffer buffer,
                long position)
         throws java.io.IOException

Description copied from interface: SimpleChannel

Read bytes into the buffer from the developer's bytes. Up to buffer.remaining bytes should to read into the buffer starting at buffer.position and continuing until either buffer.limit or the underlying byte stream runs out of bytes. Reading beyond bounds of the developer's bytes stream must NOT throw an EOFException.

Specified by:

read in interface SimpleChannel

Parameters:

buffer - Target buffer for the read bytes

position - Location in the underlying byte stream where the method should being reading bytes

Returns:

Number of bytes actually read, may be 0 or -1 if there are no more bytes to read

Throws:

java.io.IOException - Any failure to read

write

public void write(java.nio.ByteBuffer buffer,
                  long position)
           throws java.io.IOException

Description copied from interface: SimpleChannel

Writes bytes from the buffer to the developer's bytes. buffer.remaining bytes should be written starting at buffer.position and continuing until buffer.limit.

Specified by:

write in interface SimpleChannel

position - Location in the underlying byte stream where the method should being writing bytes

Throws:

java.io.IOException - Any failure to write

size

public long size()
          throws java.io.IOException

Description copied from interface: SimpleChannel

The size of the developer's bytes. Note that unlike some size methods a return value of -1 indicating that the size is unknown is not acceptable. Many file formats (most notablly PDF) cannot be processed unless the size is known.

Specified by:

size in interface SimpleChannel

Returns:

Number of bytes in the developer's byte stream.

Throws:

java.io.IOException - Any failure to get the size

supports

public int supports()

Description copied from interface: SimpleChannel

Return what operations the SimpleChannel supports

Specified by:

supports in interface SimpleChannel

Returns:

SimpleChannel.READ, SimpleChannel.WRITE or SimpleChannel.READWRITE possibly ORed with SimpleChannel.DIRECTBYTEBUFFERS

truncate

public void truncate(long size)
              throws java.io.IOException

Description copied from interface: SimpleChannel

Truncate the stream to the given length. File position will be preserved unless it is beyond the new size in which case it will be reset to the last position.

Specified by:

truncate in interface SimpleChannel

Parameters:

size - Size of the file after truncation.

Throws:

java.io.IOException

close

public void close()

Description copied from interface: SimpleChannel

Close resources associated with this SimpleChannel

Specified by:

close in interface SimpleChannel