public interface TypeDescription extends MetaDataObject
MetaDataObject, which implements
XMLizable, so it can be serialized to and deserialized from an XML
element.| Modifier and Type | Field and Description |
|---|---|
static TypeDescription[] |
EMPTY_TYPE_DESCRIPTIONS |
| Modifier and Type | Method and Description |
|---|---|
FeatureDescription |
addFeature(String aFeatureName,
String aDescription,
String aRangeTypeName)
Convenience method which adds a FeatureDescription to this TypeDescription.
|
FeatureDescription |
addFeature(String aFeatureName,
String aDescription,
String aRangeTypeName,
String aElementTypeName,
Boolean aMultipleReferencesAllowed)
Convenience method which adds a FeatureDescription to this TypeDescription.
|
AllowedValue[] |
getAllowedValues()
Gets the allowed values for instances of this Type.
|
String |
getDescription()
Gets the verbose description of this Type.
|
FeatureDescription[] |
getFeatures()
Gets the descriptions of the features for this Type.
|
String |
getName()
Gets the name of this Type.
|
String |
getSupertypeName()
Gets the name of the supertype for this Type.
|
void |
setAllowedValues(AllowedValue[] aAllowedValues)
Sets the allowed values for instances of this Type.
|
void |
setDescription(String aDescription)
Sets the verbose description of this Type.
|
void |
setFeatures(FeatureDescription[] aFeatures)
Sets the descriptions of the features for this Type.
|
void |
setName(String aName)
Sets the name of this Type.
|
void |
setSupertypeName(String aTypeName)
Sets the name of the supertype for this Type.
|
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlbuildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXMLstatic final TypeDescription[] EMPTY_TYPE_DESCRIPTIONS
String getName()
void setName(String aName)
aName - the name of this TypeString getDescription()
void setDescription(String aDescription)
aDescription - the description of this TypeString getSupertypeName()
void setSupertypeName(String aTypeName)
aTypeName - the name of the supertype for this TypeFeatureDescription[] getFeatures()
void setFeatures(FeatureDescription[] aFeatures)
aFeatures - descriptions of the features for this Type.AllowedValue[] getAllowedValues()
null. Note that if a type has allowed values, it may not
have features.void setAllowedValues(AllowedValue[] aAllowedValues)
null. Note that if a type has allowed values, it
may not have features.aAllowedValues - the allowed values for instances of this TypeFeatureDescription addFeature(String aFeatureName, String aDescription, String aRangeTypeName)
aFeatureName - name of feature to addaDescription - verbose description of the featureaRangeTypeName - name of feature's range typeFeatureDescription addFeature(String aFeatureName, String aDescription, String aRangeTypeName, String aElementTypeName, Boolean aMultipleReferencesAllowed)
aFeatureName - name of feature to addaDescription - verbose description of the featureaRangeTypeName - name of feature's range typeaElementTypeName - type of element expected to be contained in the array or listaMultipleReferencesAllowed - whether an array or list that's assigned to this feature can also be referenced from
another feature. This is a Boolean object so that the null value can be used to
represent the case where the user has not specified a value.Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.