Package htsjdk.samtools.util
Class PositionalOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- htsjdk.samtools.util.PositionalOutputStream
-
- All Implemented Interfaces:
LocationAware
,Closeable
,Flushable
,AutoCloseable
public final class PositionalOutputStream extends OutputStream implements LocationAware
Wraps output stream in a manner which keeps track of the position within the file and allowing writes at arbitrary points
-
-
Constructor Summary
Constructors Constructor Description PositionalOutputStream(OutputStream out)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
long
getPosition()
The current offset, in bytes, of this stream/writer/file.void
write(byte[] bytes)
void
write(byte[] bytes, int startIndex, int numBytes)
void
write(int c)
-
Methods inherited from class java.io.OutputStream
flush, nullOutputStream
-
-
-
-
Constructor Detail
-
PositionalOutputStream
public PositionalOutputStream(OutputStream out)
-
-
Method Detail
-
write
public final void write(byte[] bytes) throws IOException
- Overrides:
write
in classOutputStream
- Throws:
IOException
-
write
public final void write(byte[] bytes, int startIndex, int numBytes) throws IOException
- Overrides:
write
in classOutputStream
- Throws:
IOException
-
write
public final void write(int c) throws IOException
- Specified by:
write
in classOutputStream
- Throws:
IOException
-
getPosition
public final long getPosition()
Description copied from interface:LocationAware
The current offset, in bytes, of this stream/writer/file. Or, if this is an iterator/producer, the offset (in bytes) of the END of the most recently returned record (since a produced record corresponds to something that has been read already). See class javadoc for more. Note that for BGZF files, this does not represent an actually file position, but a virtual file pointer.- Specified by:
getPosition
in interfaceLocationAware
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
-
-