Class ECIChannelRecord
- All Implemented Interfaces:
jakarta.resource.cci.MappedRecord
,jakarta.resource.cci.Record
,Serializable
,Cloneable
,Map
-
Nested Class Summary
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionECIChannelRecord
(String name) Creates a new empty channel record with the specified name. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all containers from the channel.clone()
Not supported.boolean
containsKey
(Object name) Returns whether or not the specified container exists in the channel.boolean
containsValue
(Object data) Returns whether or not there is a container with the specified data within the channel.entrySet()
Returns a set of containers in name-value form.boolean
Retrieves the data for the specified container from the channel.com.ibm.ctg.client.Channel
Returns the name of the channel record.Returns the short description of the channel record.int
hashCode()
boolean
isEmpty()
Returns whether the channel is empty or not.keySet()
Returns a set of the container names in the channel.void
markDeleted
(Object name) Removes a container from the channel.Adds a container to the channel.void
Puts a group of containers into the channel.Removes a container from the channel.void
setChannel
(com.ibm.ctg.client.Channel myChannel) void
setRecordName
(String name) This method does not change the record name.void
setRecordShortDescription
(String description) Sets the short description of the channel record.int
size()
Returns the number of containers in the channel.Collection<?>
values()
Returns the contents of all the containers in the channel.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Field Details
-
CLASS_VERSION
- See Also:
-
-
Constructor Details
-
ECIChannelRecord
Creates a new empty channel record with the specified name.The channel name must be between 1 and 16 characters in length and must consist of only the following types of character:
- Uppercase characters (A-Z)
- Lowercase characters (a-z)
- Digits (0-9)
- Special characters < > $ @ # / % ? ! : | " = ' ; . - and _
Channel names are case sensitive.
- Parameters:
name
- The name of the channel.- Throws:
jakarta.resource.ResourceException
- if name is null or contains invalid characters, or the length of name is invalid.
-
-
Method Details
-
getRecordName
Returns the name of the channel record.- Specified by:
getRecordName
in interfacejakarta.resource.cci.Record
-
getRecordShortDescription
Returns the short description of the channel record.- Specified by:
getRecordShortDescription
in interfacejakarta.resource.cci.Record
-
setRecordName
This method does not change the record name. Channel names are immutable. This method exists solely to conform to the MappedRecord interface.- Specified by:
setRecordName
in interfacejakarta.resource.cci.Record
-
setRecordShortDescription
Sets the short description of the channel record.- Specified by:
setRecordShortDescription
in interfacejakarta.resource.cci.Record
-
clear
public void clear()Removes all containers from the channel. -
containsKey
Returns whether or not the specified container exists in the channel.- Specified by:
containsKey
in interfaceMap
- Parameters:
name
- A container name.
-
containsValue
Returns whether or not there is a container with the specified data within the channel.- Specified by:
containsValue
in interfaceMap
- Parameters:
data
- A String or byte[].- Returns:
- true if there is a container with the specified data, false otherwise.
-
entrySet
Returns a set of containers in name-value form. -
get
Retrieves the data for the specified container from the channel. -
isEmpty
public boolean isEmpty()Returns whether the channel is empty or not. -
keySet
Returns a set of the container names in the channel. -
put
Adds a container to the channel. If a container of the same name already exists in the channel, the existing container is replaced with the new container.The container name must be between 1 and 16 characters in length and must consist of only the following types of character:
- Uppercase characters (A-Z)
- Lowercase characters (a-z)
- Digits (0-9)
- Special characters < > $ @ # / % ? ! : | " = ' ; . - and _
Container names are case sensitive.
To create a CHAR container, the data parameter must be of type String. To create a BIT container, the data parameter must be of type byte[] or be a type that implements the Streamable interface.
-
putAll
Puts a group of containers into the channel. Any containers of the same name that already exist in the channel are replaced with the new versions of the containers.Container names must be between 1 and 16 characters in length and must consist of only the following types of character:
- Uppercase characters (A-Z)
- Lowercase characters (a-z)
- Digits (0-9)
- Special characters < > $ @ # / % ? ! : | " = ' ; . - and _
Container names are case sensitive.
To create a CHAR container, the data parameter must be of type String. To create a BIT container, the data parameter must be of type byte[] or be a type that implements the Streamable interface.
-
remove
Removes a container from the channel. -
markDeleted
Removes a container from the channel.- Parameters:
name
- The name of the container to remove.
-
size
public int size()Returns the number of containers in the channel. -
values
Returns the contents of all the containers in the channel. -
clone
Not supported.- Specified by:
clone
in interfacejakarta.resource.cci.Record
- Throws:
CloneNotSupportedException
-
getChannel
public com.ibm.ctg.client.Channel getChannel() -
setChannel
public void setChannel(com.ibm.ctg.client.Channel myChannel) -
equals
-
hashCode
public int hashCode()
-