public interface ReadableBITContainer extends ReadableContainer<byte[]>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
Copyright
|
Modifier and Type | Method and Description |
---|---|
default java.io.InputStream |
asInputStream(int bufferSize)
Get the content of this CICS Container as an
InputStream . |
byte[] |
get()
Read the contents of this container as a byte[]
|
default <T> T |
getWith(Deserializer<T> deserializer)
Read the content of the container into an object of type
T , using
the provided Deserializer . |
default <T> T |
getWith(Deserializer<T> deserializer,
int chunkSize)
Read the content of the container into an object of type
T , using
the provided Deserializer . |
default int |
read(byte[] into)
Read the contents of the CICS Container into an application supplied byte[].
|
int |
read(byte[] into,
int destOff,
int srcOff,
int length)
Read part of the contents of the CICS Container into part of an application supplied byte[]
|
default <T> ReadableContainer<T> |
with(Deserializer<T> deserializer)
Return a container that wraps this container and allows objects of type
T to be retrieved from it directly. |
default <T> ReadableContainer<T> |
with(Deserializer<T> deserializer,
int chunkSize)
Return a container that wraps this container and allows objects of type
T to be retrieved from it directly. |
static final java.lang.String COPYRIGHT
byte[] get() throws CICSConditionException
EXEC CICS API commands:
EXEC CICS GET CONTAINER
get
in interface ReadableContainer<byte[]>
CICSConditionException
- if there is a problem getting the data from CICS
RespCodes:
default int read(byte[] into) throws CICSConditionException
EXEC CICS API commands:
EXEC CICS GET CONTAINER
into
- a byte[] in which to store the Container data, starting at offset 0CICSConditionException
- if there is a problem getting the data from CICS
RespCodes:
int read(byte[] into, int destOff, int srcOff, int length) throws CICSConditionException
EXEC CICS API commands:
EXEC CICS GET CONTAINER
into
- a byte[] in which to store the Container datadestOff
- the offset within the destination byte[] at which to start writing datasrcOff
- the offset within the source Container from which to start reading datalength
- the maximum length of data to read in bytesCICSConditionException
- if there is a problem getting the data from CICS
RespCodes:
default java.io.InputStream asInputStream(int bufferSize)
InputStream
.
This stream is internally buffered to read data from the CICS
container in chunks of bufferSize
bytes.bufferSize
- how many bytes to read at onceInputStream
default <T> ReadableContainer<T> with(Deserializer<T> deserializer, int chunkSize)
T
to be retrieved from it directly.
Objects will be deserialized from the wrapped BIT container using the
supplied Deserializer
. Some Deserializer
s are available using
static methods on the Deserializers
class, or can be custom-written.
This implementation will load data from the underlying CICS container in
chunks of chunkSize
. For an implementation that loads all that data
from the container at once, see
with(Deserializer)
T
- The type that the Deserializer
deserializes bytes intochunkSize
- How many bytes to load from the CICS container at a timedeserializer
- The Deserializer
used to read the content of the
container into an objectT
directlydefault <T> ReadableContainer<T> with(Deserializer<T> deserializer)
T
to be retrieved from it directly.
Objects will be deserialized from the wrapped BIT container using the
supplied Deserializer
. Some Deserializer
s are available using
static methods on the Deserializers
class, or can be custom-written.
This implementation will load all data from the underlying CICS container
at once. For an implementation that loads the data in chunks, see
with(Deserializer, int)
.
T
- The type that the Deserializer
deserializes bytes intodeserializer
- The Deserializer
used to read the content of the
container into an objectT
directlydefault <T> T getWith(Deserializer<T> deserializer) throws java.io.IOException, CICSConditionException
T
, using
the provided Deserializer
. This effectively calls
with(Deserializer)
followed by ReadableContainer.get()
.
The object will be deserialized from the wrapped BIT container using the
supplied Deserializer
. Some Deserializer
s are available using
static methods on the Deserializers
class, or can be custom-written.
This implementation will load all data from the underlying CICS container
at once. For an implementation that loads the data in chunks, see
getWith(Deserializer, int)
.
T
- The type that the Deserializer
deserializes bytes intodeserializer
- The Deserializer
used to read the content of the
container into an objectjava.io.IOException
- If there is a problem deserializing the dataCICSConditionException
- if there is a problem getting the data from CICS
For EXEC CICS
and RespCode
information see
ReadableContainer.get()
default <T> T getWith(Deserializer<T> deserializer, int chunkSize) throws java.io.IOException, CICSConditionException
T
, using
the provided Deserializer
. This effectively calls
with(Deserializer, int)
followed by ReadableContainer.get()
The object will be deserialized from the wrapped BIT container using the
supplied Deserializer
. Some Deserializer
s are available using
static methods on the Deserializers
class, or can be custom-written.
This implementation will load data from the underlying CICS container in
chunks of chunkSize
. For an implementation that loads all that data
from the container at once, see
getWith(Deserializer)
T
- The type that the Deserializer
deserializes bytes intochunkSize
- How many bytes to load from the CICS container at a timedeserializer
- The Deserializer
used to read the content of the
container into an objectjava.io.IOException
- If there is a problem deserializing the dataCICSConditionException
- if there is a problem getting the data from CICS.
For EXEC CICS
and RespCode
information, see
ReadableContainer.get()