com.ibm.ctg.client
Enum Container.ContainerType

java.lang.Object
  java.lang.Enum<Container.ContainerType>
      com.ibm.ctg.client.Container.ContainerType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Container.ContainerType>

Enclosing interface:

Container

public static enum Container.ContainerType
extends java.lang.Enum<Container.ContainerType>

Defines the type of data in a Container and whether it is subject to code page conversion.

For data conversion purposes, CICS recognizes two types of data:

CHAR

Character data is a text string. The data in the container is converted, if necessary, from its defined code page to the code page of the application that retrieves it. If the application that retrieves the data is a client on an American Standard Code for Information Interchange (ASCII) based system, then this is an ASCII code page.

All the data in a container is converted as though it were a single character string. For single-byte character set (SBCS) code pages this is not a problem, since a structure consisting of several character fields can be interpreted as a single-byte character string. However, for double-byte character set (DBCS) code pages this is not the case. This is because DBCS code pages may consist of character strings made up of double-byte characters or a mixture of single-byte and double-byte characters. Changing between single-byte and double-byte characters may be identified by special characters with the assumption that encoding starts in single-byte mode. Concatenating such strings might cause subsequent strings to be incorrectly interpreted as being in double-byte mode. To ensure that interpretation of DBCS strings and data conversion work correctly, complete DBCS strings must be put into separate containers.

BIT

All data that is not designated as being of type CHAR is treated as non-character data. Data in the container is not converted. This is the default value, unless FROMCCSID is specified in the PUT CONTAINER (CHANNEL) CICS call.

Enum Constant Summary

BIT
The container type is BIT.

CHAR
The container type is CHAR.

Method Summary

byte	getByte() Gets a byte representing this ContainerType.
static Container.ContainerType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Container.ContainerType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BIT

public static final Container.ContainerType BIT

The container type is BIT. Data in the container is not converted.

CHAR

public static final Container.ContainerType CHAR

The container type is CHAR. Data in the container is converted from the code page of the container to the code page of the platform.

Method Detail

values

public static final Container.ContainerType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Container.ContainerType c : Container.ContainerType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static Container.ContainerType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getByte

public byte getByte()

Gets a byte representing this ContainerType.

Returns:

a byte value representing this ContainerType.