Package com.itextpdf.text.io
Interface RandomAccessSource
-
- All Known Implementing Classes:
ArrayRandomAccessSource
,ByteBufferRandomAccessSource
,FileChannelRandomAccessSource
,GetBufferedRandomAccessSource
,GroupedRandomAccessSource
,IndependentRandomAccessSource
,MappedChannelRandomAccessSource
,PagedChannelRandomAccessSource
,RAFRandomAccessSource
,WindowRandomAccessSource
public interface RandomAccessSource
Represents an abstract source that bytes can be read from. This class forms the foundation for all byte input in iText. Implementations do not keep track of a current 'position', but rather provide absolute get methods. Tracking position should be handled in classes that use RandomAccessSource internally (via composition).- Since:
- 5.3.5
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Closes this source.int
get(long position)
Gets a byte at the specified positionint
get(long position, byte[] bytes, int off, int len)
Gets an array at the specified position.long
length()
-
-
-
Method Detail
-
get
int get(long position) throws java.io.IOException
Gets a byte at the specified position- Parameters:
position
-- Returns:
- the byte, or -1 if EOF is reached
- Throws:
java.io.IOException
-
get
int get(long position, byte[] bytes, int off, int len) throws java.io.IOException
Gets an array at the specified position. If the number of bytes requested cannot be read, the bytes that can be read will be placed in bytes and the number actually read will be returned.- Parameters:
position
- the position in the RandomAccessSource to read frombytes
- output bufferoff
- offset into the output buffer where results will be placedlen
- the number of bytes to read- Returns:
- the number of bytes actually read, or -1 if the file is at EOF
- Throws:
java.io.IOException
-
length
long length()
- Returns:
- the length of this source
-
close
void close() throws java.io.IOException
Closes this source. The underlying data structure or source (if any) will also be closed- Throws:
java.io.IOException
-
-