Package htsjdk.beta.io.bundle
Class OutputStreamResource
java.lang.Object
htsjdk.beta.io.bundle.BundleResourceBase
htsjdk.beta.io.bundle.OutputStreamResource
- All Implemented Interfaces:
BundleResource
,Serializable
A
BundleResource
backed by an OutputStream
.- See Also:
-
Constructor Summary
ConstructorDescriptionOutputStreamResource
(OutputStream outputStream, String displayName, String contentType) Create aBundleResource
backed by an OutputStream, specifying a display name and content type.OutputStreamResource
(OutputStream outputStream, String displayName, String contentType, String format) Create a BundleResource backed by an OutputStream, specifying a display name, content type and format. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Get anOutputStream
for this resource, or Optional.empty.getSignatureStream
(int signatureProbeLength) Get aSignatureStream
for this resource.int
hashCode()
boolean
Return true if this resource is backed by a type that can be used for output.toString()
Methods inherited from class htsjdk.beta.io.bundle.BundleResourceBase
getContentType, getDisplayName, getFileFormat, getInputStream, getIOPath, getSeekableStream, hasInputType, hasSeekableStream
-
Constructor Details
-
OutputStreamResource
Create aBundleResource
backed by an OutputStream, specifying a display name and content type.- Parameters:
outputStream
- TheOutputStream
to use for this resource. May not be null.displayName
- The display name for this resource. May not be null or 0-length.contentType
- The content type for this resource. May not be null or 0-length.
-
OutputStreamResource
public OutputStreamResource(OutputStream outputStream, String displayName, String contentType, String format) Create a BundleResource backed by an OutputStream, specifying a display name, content type and format.- Parameters:
outputStream
- TheOutputStream
to use for this resource. May not be null.displayName
- The display name for this resource. May not be null or 0-length.contentType
- The content type for this resource. May not be null or 0-length.format
- The format for this resource. May not be null or 0-length.
-
-
Method Details
-
getOutputStream
Description copied from interface:BundleResource
Get anOutputStream
for this resource, or Optional.empty.- Specified by:
getOutputStream
in interfaceBundleResource
- Overrides:
getOutputStream
in classBundleResourceBase
- Returns:
- an
OutputStream
for this resource, or Optional.empty ifBundleResource.hasOutputType()
is false for this resource
-
getSignatureStream
Description copied from interface:BundleResource
Get aSignatureStream
for this resource. This method requires access to the firstsignatureProbeLength
bytes of the underlying resource.BundleResource
implementations that are backed by raw streams that can only be consumed once, such asInputStreamResource
, may consume and buffer a portion of the underlying resource's stream in order to allow subsequent callers of theBundleResource.getInputStream()
) method to be presented with the entire stream, including the signature. Calls to this method may have the side effect of changing or resetting the current position of the underlying stream; serial calls toBundleResource.getSignatureStream(int)
on the same object are not necessarily idempotent; and implementations are free to throw to prevent serial calls to this method.- Parameters:
signatureProbeLength
- the number of bytes of the underlying resource to include in theSignatureStream
stream.signatureProbeLength
should be expressed in "compressed(/encrypted)" space rather than "plaintext" space. For example, a file format signature may consist ofn
bytes of ASCII, but for formats that use compressed streams, the codec may need access to an entire compressed block in order to inspect thosen
bytes.signatureProbeLength
should use the compressed block size, in order to ensure that theSignatureStream
contains a semantically meaningful fragment of the underlying input.- Returns:
- a
SignatureStream
over the firstsignatureProbeLength
bytes of this resource, for use with signature probing for codec resolution. Only applicable to resources for whichBundleResource.hasInputType()
is true.
-
hasOutputType
public boolean hasOutputType()Description copied from interface:BundleResource
Return true if this resource is backed by a type that can be used for output. Some resource types, such asInputStreamResource
, can be used for input but not for output (seeBundleResource.hasOutputType()
. Others, such asOutputStreamResource
, can be used for output but not for input. Some resource types may be suitable for both (for example seeIOPathResource
).The determination is based only on the type of the resource, and does not imply a guarantee about whether the resource is actually writeable.
- Specified by:
hasOutputType
in interfaceBundleResource
- Overrides:
hasOutputType
in classBundleResourceBase
- Returns:
- true if the type of this resource makes it suitable for use as target for output.
-
equals
- Overrides:
equals
in classBundleResourceBase
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBundleResourceBase
-
toString
- Overrides:
toString
in classBundleResourceBase
-