public interface ContainerInfo
extends java.io.Serializable
ChannelInfo
Modifier and Type | Interface and Description |
---|---|
static class |
ContainerInfo.DataType
Defines the type of data in a container and whether it is subject to code
page conversion.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
getBitData()
Returns a byte array that is a copy of the data in the container.
|
byte[] |
getBitData(int offset,
int length)
Returns a byte array copy of length bytes taken from offset bytes
into the container.
|
int |
getCCSID()
Gets the CCSID of the character data in the container
|
java.lang.String |
getCharData()
Returns a string that is a copy of the data in the container.
|
java.lang.String |
getCharData(int offset,
int length)
Returns a String copy of length characters taken from offset characters
into the container.
|
int |
getLength()
Gets the length of the data in the container.
|
java.lang.String |
getName()
Gets the name of the container.
|
ContainerInfo.DataType |
getType()
Gets the data type of the container.
|
java.lang.String getName()
int getLength()
BIT
containers the data length is measured in bytes, and for CHAR
containers the data length is measured in characters.getType()
ContainerInfo.DataType getType()
BIT
containers hold binary data. Code page conversion
is not performed when applications read or update the contents of the
container.
CHAR
containers hold character data. Code page
conversion is performed when applications read or update the contents of
the container.
byte[] getBitData() throws InvalidContainerTypeException, ContainerInfoContentException
RequestExit
eventFired()
method.InvalidContainerTypeException
- if this is not a BIT
containerContainerInfoContentException
- if container data is no longer validbyte[] getBitData(int offset, int length) throws java.lang.IndexOutOfBoundsException, InvalidContainerTypeException, ContainerInfoContentException
RequestExit
eventFired()
method.offset
- the starting byte offset into the containerlength
- the number of bytes to copyjava.lang.IndexOutOfBoundsException
- if
the offset is less than 0 or greater than the length of the container
or the length is less than 0 or greater than the length of the container
less the offsetInvalidContainerTypeException
- if this is not a BIT
containerContainerInfoContentException
- if container data is no longer validjava.lang.String getCharData() throws InvalidContainerTypeException, ContainerInfoContentException
RequestExit
eventFired()
method.InvalidContainerTypeException
- if this is not a CHAR
containerContainerInfoContentException
- if container data is no longer validjava.lang.String getCharData(int offset, int length) throws java.lang.IndexOutOfBoundsException, InvalidContainerTypeException, ContainerInfoContentException
RequestExit
eventFired()
method.offset
- the starting character offset into the containerlength
- the number of characters to copyjava.lang.IndexOutOfBoundsException
- if
the offset is less than 0 or greater than the length of the container
or the length is less than 0 or greater than the length of the container
less the offsetInvalidContainerTypeException
- if this is not a CHAR
containerContainerInfoContentException
- if container data is no longer validint getCCSID() throws InvalidContainerTypeException
InvalidContainerTypeException
- if this is not a CHAR
container