public class ECIChannelRecord
extends java.lang.Object
implements javax.resource.cci.MappedRecord
| Constructor and Description |
|---|
ECIChannelRecord(java.lang.String name)
Creates a new empty channel record with the specified name.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Removes all containers from the channel.
|
java.lang.Object |
clone()
Not supported.
|
boolean |
containsKey(java.lang.Object name)
Returns whether or not the specified container exists in the channel.
|
boolean |
containsValue(java.lang.Object data)
Returns whether or not there is a container with the specified data within the channel.
|
boolean |
equals(java.lang.Object o) |
java.lang.Object |
get(java.lang.Object name)
Retrieves the data for the specified container from the channel.
|
Channel |
getChannel() |
java.lang.String |
getRecordName()
Returns the name of the channel record.
|
java.lang.String |
getRecordShortDescription()
Returns the short description of the channel record.
|
int |
hashCode() |
boolean |
isEmpty()
Returns whether the channel is empty or not.
|
java.util.Set |
keySet()
Returns a set of the container names in the channel.
|
void |
markDeleted(java.lang.Object name)
Removes a container from the channel.
|
java.lang.Object |
put(java.lang.Object name,
java.lang.Object data)
Adds a container to the channel.
|
void |
putAll(java.util.Map containers)
Puts a group of containers into the channel.
|
java.lang.Object |
remove(java.lang.Object name)
Removes a container from the channel.
|
void |
setChannel(Channel myChannel) |
void |
setRecordName(java.lang.String name)
This method does not change the record name.
|
void |
setRecordShortDescription(java.lang.String description)
Sets the short description of the channel record.
|
int |
size()
Returns the number of containers in the channel.
|
java.util.Collection<?> |
values()
Returns the contents of all the containers in the channel.
|
public ECIChannelRecord(java.lang.String name)
throws javax.resource.ResourceException
The channel name must be between 1 and 16 characters in length and must consist of only the following types of character:
Channel names are case sensitive.
name - The name of the channel.javax.resource.ResourceException - if name is null or contains invalid characters,
or the length of name is invalid.public java.lang.String getRecordName()
getRecordName in interface javax.resource.cci.Recordpublic java.lang.String getRecordShortDescription()
getRecordShortDescription in interface javax.resource.cci.Recordpublic void setRecordName(java.lang.String name)
setRecordName in interface javax.resource.cci.Recordpublic void setRecordShortDescription(java.lang.String description)
setRecordShortDescription in interface javax.resource.cci.Recordpublic void clear()
clear in interface java.util.Mappublic boolean containsKey(java.lang.Object name)
containsKey in interface java.util.Mapname - A container name.public boolean containsValue(java.lang.Object data)
containsValue in interface java.util.Mapdata - A String or byte[].public java.lang.Object get(java.lang.Object name)
get in interface java.util.Mapname - The name of the container to retrieve.public boolean isEmpty()
isEmpty in interface java.util.Mappublic java.util.Set keySet()
keySet in interface java.util.Mappublic java.lang.Object put(java.lang.Object name,
java.lang.Object data)
The container name must be between 1 and 16 characters in length and must consist of only the following types of character:
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.
put in interface java.util.Mapname - The name of the container.data - The container data.public void putAll(java.util.Map containers)
Container names must be between 1 and 16 characters in length and must consist of only the following types of character:
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 in interface java.util.Mapcontainers - A map of container names to container data.public java.lang.Object remove(java.lang.Object name)
remove in interface java.util.Mapname - The name of the container to remove.public void markDeleted(java.lang.Object name)
name - The name of the container to remove.public int size()
size in interface java.util.Mappublic java.util.Collection<?> values()
values in interface java.util.Mappublic java.lang.Object clone()
throws java.lang.CloneNotSupportedException
clone in interface javax.resource.cci.Recordclone in class java.lang.Objectjava.lang.CloneNotSupportedExceptionpublic Channel getChannel()
public void setChannel(Channel myChannel)
public boolean equals(java.lang.Object o)
equals in interface java.util.Mapequals in interface javax.resource.cci.Recordequals in class java.lang.Objectpublic int hashCode()
hashCode in interface java.util.MaphashCode in interface javax.resource.cci.RecordhashCode in class java.lang.Object