com.ibm.cics.server

Class KeyHolder

java.lang.Object

com.ibm.cics.server.KeyHolder

All Implemented Interfaces:

IHolder

public class KeyHolder
extends java.lang.Object
implements IHolder

This class holds an array of bytes that is the key of a file. The actual data is an instance variable of type byte[] with the name value.

Since CICS TS version:

1.3

Since package version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	value Deprecated. - Direct access to this field will not be allowed in a future release This will be made private, use the getter methods instead.

Constructor Summary

Constructors

Constructor and Description
KeyHolder() Constructs a KeyHolder without a value.
KeyHolder(byte[] initialValue) Constructs a KeyHolder without a value.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getStringValue() Returns a String derived from the data in the IHolder, assuming that the data is encoded in the LOCALCCSID.
byte[]	getValue() Returns the raw byte array from the IHolder

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

@Deprecated
public byte[] value

Deprecated. - Direct access to this field will not be allowed in a future release This will be made private, use the getter methods instead.

The array of bytes comprising the item.

Since CICS TS version:

1.3

Since package version:

1.0

Constructor Detail

KeyHolder

public KeyHolder()

Constructs a KeyHolder without a value.

Since CICS TS version:

1.3

Since package version:

1.0

KeyHolder

public KeyHolder(byte[] initialValue)

Constructs a KeyHolder without a value.

Parameters:

initialValue - the initial value

Since CICS TS version:

1.3

Since package version:

1.0

Method Detail

getValue

public byte[] getValue()

Description copied from interface: IHolder

Returns the raw byte array from the IHolder

Specified by:

getValue in interface IHolder

Returns:

- the raw byte value stored in the IHolder

See Also:

IHolder.getValue()

Since CICS TS version:

5.1

Since package version:

1.401.0

getStringValue

public java.lang.String getStringValue()

Description copied from interface: IHolder

Returns a String derived from the data in the IHolder, assuming that the data is encoded in the LOCALCCSID. The behavior of this method when the bytes are not valid in the LOCALCCSID encoding is unspecified.

Specified by:

getStringValue in interface IHolder

Returns:

- a String representation of the byte-array in the CICS LOCALCCSID.

See Also:

IHolder.getStringValue()

Since CICS TS version:

5.1

Since package version:

1.401.0