Package org.apache.xmlbeans
Interface SchemaField
- All Known Subinterfaces:
SchemaGlobalAttribute,SchemaGlobalElement,SchemaLocalAttribute,SchemaLocalElement
- All Known Implementing Classes:
SchemaGlobalAttributeImpl,SchemaGlobalElementImpl,SchemaLocalAttributeImpl,SchemaLocalElementImpl
public interface SchemaField
Represents an element or an attribute declaration.
-
Method Summary
Modifier and Type Method Description StringgetDefaultText()The default value as plain text.XmlAnySimpleTypegetDefaultValue()The default value as a strongly-typed value.BigIntegergetMaxOccurs()Returns the maxOccurs value for this particle, or null if it is unbounded.BigIntegergetMinOccurs()Returns the minOccurs value for this particle.QNamegetName()Returns the form-unqualified-or-qualified name.SchemaTypegetType()Returns the type of this use.ObjectgetUserData()Returns user-specific information.booleanisAttribute()True if this use is an attributebooleanisDefault()True if a default is supplied.booleanisFixed()True if the value is fixed.booleanisNillable()True if nillable; always false for attributes.
-
Method Details
-
getName
QName getName()Returns the form-unqualified-or-qualified name. -
isAttribute
boolean isAttribute()True if this use is an attribute -
isNillable
boolean isNillable()True if nillable; always false for attributes. -
getType
SchemaType getType()Returns the type of this use. -
getMinOccurs
BigInteger getMinOccurs()Returns the minOccurs value for this particle. If it is not specified explicitly, this defaults to BigInteger.ONE. -
getMaxOccurs
BigInteger getMaxOccurs()Returns the maxOccurs value for this particle, or null if it is unbounded. If it is not specified explicitly, this defaults to BigInteger.ONE. -
getDefaultText
String getDefaultText()The default value as plain text. SeeisDefault()andisFixed(). -
getDefaultValue
XmlAnySimpleType getDefaultValue()The default value as a strongly-typed value. SeeisDefault()andisFixed(). -
isDefault
boolean isDefault()True if a default is supplied. IfisFixed(), then isDefault is always true. -
isFixed
boolean isFixed()True if the value is fixed. -
getUserData
Object getUserData()Returns user-specific information.- See Also:
SchemaBookmark
-