public class CompositeDataDescriptor extends DataDescriptor
The value returned by its getElementDescriptors()
method describes all the elements in the composite.
Default value, legal value choices, and value choices are not supported for CompositeDataDescriptor.
Constructor and Description |
---|
CompositeDataDescriptor(java.lang.String name,
java.lang.String desc,
DataDescriptor[] elementDescriptors)
Constructs a CompositeDataDescriptor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares this object against the specified object.
|
DataDescriptor[] |
getElementDescriptors()
Returns the descriptors of the aggregated elements
|
boolean |
isOpenData()
Returns true if this descriptor describes an open data type.
|
java.lang.String |
toString()
Returns a string representation of this descriptor.
|
getDefault, getDescription, getLegalValueChoices, getName, getType, getValueChoices
public CompositeDataDescriptor(java.lang.String name, java.lang.String desc, DataDescriptor[] elementDescriptors)
Note that a type
parameter is not required as in DataDescriptor,
it is implicitly the CompositeData type.
name
- The name of the data parameter being described. It must be a non-null,
non-empty alpha numeric string.desc
- A description of the parameter being described.elementDescriptors
- An array of descriptors describing the components of
the CompositeData. It must contain DataDescriptor objects
that describe only open data types. All elements must have unique names.
It can not be null or empty array. The array can not contain null elements.public DataDescriptor[] getElementDescriptors()
public boolean isOpenData()
This overridden method will always return true for this subclass of DataDescriptor
because the constructor insures that only the open data type CompositeData
may be described.
isOpenData
in class DataDescriptor
public boolean equals(java.lang.Object obj)
Two descriptors are equal if their name, type, description, and DataDescriptor elements are equal.
equals
in class DataDescriptor
public java.lang.String toString()
toString
in class DataDescriptor
Copyright © 2000-2019 TIBCO Inc. All Rights Reserved.