|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.builder.binding.xml.EnumBindingType
public class EnumBindingType
This type allows the mapping between an XML schema enumeration and a java class that follows the type-safe enumeration paradigm. Additionally, it allows the specify the name of the Java constant definition for a given enumeraton value.
Constructor Summary | |
---|---|
EnumBindingType()
|
Method Summary | |
---|---|
void |
addEnumMember(EnumMember vEnumMember)
|
void |
addEnumMember(int index,
EnumMember vEnumMember)
|
java.util.Enumeration |
enumerateEnumMember()
Method enumerateEnumMember. |
EnumClassName |
getEnumClassName()
Returns the value of field 'enumClassName'. |
EnumMember[] |
getEnumMember()
Method getEnumMember.Returns the contents of the collection in an Array. |
EnumMember |
getEnumMember(int index)
Method getEnumMember. |
int |
getEnumMemberCount()
Method getEnumMemberCount. |
boolean |
isValid()
Method isValid. |
java.util.Iterator |
iterateEnumMember()
Method iterateEnumMember. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllEnumMember()
|
boolean |
removeEnumMember(EnumMember vEnumMember)
Method removeEnumMember. |
EnumMember |
removeEnumMemberAt(int index)
Method removeEnumMemberAt. |
void |
setEnumClassName(EnumClassName enumClassName)
Sets the value of field 'enumClassName'. |
void |
setEnumMember(EnumMember[] vEnumMemberArray)
|
void |
setEnumMember(int index,
EnumMember vEnumMember)
|
static EnumBindingType |
unmarshalEnumBindingType(java.io.Reader reader)
Method unmarshalEnumBindingType. |
void |
validate()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EnumBindingType()
Method Detail |
---|
public void addEnumMember(EnumMember vEnumMember) throws java.lang.IndexOutOfBoundsException
vEnumMember
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addEnumMember(int index, EnumMember vEnumMember) throws java.lang.IndexOutOfBoundsException
index
- vEnumMember
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration enumerateEnumMember()
public EnumClassName getEnumClassName()
public EnumMember getEnumMember(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic EnumMember[] getEnumMember()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public int getEnumMemberCount()
public boolean isValid()
public java.util.Iterator iterateEnumMember()
public void marshal(java.io.Writer out) throws MarshalException, ValidationException
out
-
MarshalException
- if object is
null or if any SAXException is thrown during marshaling
ValidationException
- if this
object is an invalid instance according to the schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, MarshalException, ValidationException
handler
-
java.io.IOException
- if an IOException occurs during
marshaling
ValidationException
- if this
object is an invalid instance according to the schema
MarshalException
- if object is
null or if any SAXException is thrown during marshalingpublic void removeAllEnumMember()
public boolean removeEnumMember(EnumMember vEnumMember)
vEnumMember
-
public EnumMember removeEnumMemberAt(int index)
index
-
public void setEnumClassName(EnumClassName enumClassName)
enumClassName
- the value of field 'enumClassName'.public void setEnumMember(int index, EnumMember vEnumMember) throws java.lang.IndexOutOfBoundsException
index
- vEnumMember
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setEnumMember(EnumMember[] vEnumMemberArray)
vEnumMemberArray
- public static EnumBindingType unmarshalEnumBindingType(java.io.Reader reader) throws MarshalException, ValidationException
reader
-
MarshalException
- if object is
null or if any SAXException is thrown during marshaling
ValidationException
- if this
object is an invalid instance according to the schemapublic void validate() throws ValidationException
ValidationException
- if this
object is an invalid instance according to the schema
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |