Interface RandomAccessContent
-
- All Superinterfaces:
java.io.DataInput
,java.io.DataOutput
- All Known Implementing Classes:
AbstractRandomAccessContent
,AbstractRandomAccessStreamContent
,MonitorRandomAccessContent
,RamFileRandomAccessContent
public interface RandomAccessContent extends java.io.DataOutput, java.io.DataInput
Provides random access over content.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
close()
Closes this random access file stream and releases any system resources associated with the stream.long
getFilePointer()
Returns the current offset in this file.java.io.InputStream
getInputStream()
Get the input stream.long
length()
Returns the length of this file.void
seek(long pos)
Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.void
setLength(long newLength)
Sets the length of this content.
-
-
-
Method Detail
-
close
void close() throws java.io.IOException
Closes this random access file stream and releases any system resources associated with the stream.A closed random access file cannot perform input or output operations and cannot be reopened.
If this file has an associated channel then the channel is closed as well.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
getFilePointer
long getFilePointer() throws java.io.IOException
Returns the current offset in this file.- Returns:
- the offset from the beginning of the file, in bytes, at which the next read or write occurs.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
getInputStream
java.io.InputStream getInputStream() throws java.io.IOException
Get the input stream.Notice: If you use
seek(long)
you have to re-get the InputStream- Returns:
- the InputStream.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
length
long length() throws java.io.IOException
Returns the length of this file.- Returns:
- the length of this file, measured in bytes.
- Throws:
java.io.IOException
- if an I/O error occurs.
-
seek
void seek(long pos) throws java.io.IOException
Sets the file-pointer offset, measured from the beginning of this file, at which the next read or write occurs.The offset may be set beyond the end of the file. Setting the offset beyond the end of the file does not change the file length. The file length will change only by writing after the offset has been set beyond the end of the file.
Notice: If you use
getInputStream()
you have to re-get the InputStream after callingseek(long)
- Parameters:
pos
- the offset position, measured in bytes from the beginning of the file, at which to set the file pointer.- Throws:
java.io.IOException
- ifpos
is less than0
or if an I/O error occurs.
-
setLength
void setLength(long newLength) throws java.io.IOException
Sets the length of this content.If the the
newLength
argument is smaller thanlength()
, the content is truncated.If the the
newLength
argument is greater thanlength()
, the content grows with undefined data.- Parameters:
newLength
- The desired content length- Throws:
java.io.IOException
- If an I/O error occurs- Since:
- 2.1
-
-