JAXB OSGI 4.0.9 · com.sun.xml.xsom.XSElementDecl · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	canBeSubstitutedBy(XSElementDecl e) Returns true if this element declaration can be validly substituted by the given declaration.
public XmlString	getDefaultValue()
public XmlString	getFixedValue()
public Boolean	Returns: null if form attribute not present, true if form attribute present and set to qualified, false if form attribute present and set to unqualified. getForm() Used for javadoc schema generation
public List<XSIdentityConstraint>	Returns: never null, but can be empty. getIdentityConstraints() Returns all the `XSIdentityConstraint`s in this element decl.
public XSElementDecl	getSubstAffiliation() Gets the substitution head of this element, if any.
public Set<? extends XSElementDecl>	Returns: nun-null unmodifiable list. The returned list always contains this element decl itself. getSubstitutables() Returns the element declarations that can substitute this element.
public XSType	Returns: always non-null. getType() Gets the type of this element declaration.
public boolean	isAbstract()
public boolean	isNillable()
public boolean	isSubstitutionDisallowed(int Possible values are `XSType#EXTENSION`, `XSType.RESTRICTION`, or `XSType.SUBSTITUTION` method) Checks the diallowed substitution property of the schema component.
public boolean	isSubstitutionExcluded(int Possible values are `XSType#EXTENSION` or `XSType.RESTRICTION`. method) Checks the substitution excluded property of the schema component.
public XSElementDecl[]	Returns: nun-null valid array. The return value always contains this element decl itself. listSubstitutables() Deprecated this method allocates a new array every time, so it could be inefficient when working with a large schema. Returns the element declarations that can substitute this element.

Inherited from com.sun.xml.xsom.XSDeclaration:: getName getTargetNamespace isAnonymous isGlobal isLocal
Inherited from com.sun.xml.xsom.XSTerm:: apply apply asElementDecl asModelGroup asModelGroupDecl asWildcard isElementDecl isModelGroup isModelGroupDecl isWildcard visit

Method Detail

canBeSubstitutedBy back to summary

canBeSubstitutedBy	back to summary
public boolean canBeSubstitutedBy(XSElementDecl e) Returns true if this element declaration can be validly substituted by the given declaration. Just a short cut of `getSubstitutables().contain(e);`

public boolean canBeSubstitutedBy(XSElementDecl e)

Returns true if this element declaration can be validly substituted by the given declaration.

Just a short cut of getSubstitutables().contain(e);

getDefaultValue	back to summary
public XmlString getDefaultValue()

getFixedValue	back to summary
public XmlString getFixedValue()

getForm	back to summary
public Boolean getForm() Used for javadoc schema generation Returns:Boolean null if form attribute not present, true if form attribute present and set to qualified, false if form attribute present and set to unqualified.

getForm

back to summary

public Boolean getForm()

Used for javadoc schema generation

Returns:Boolean: null if form attribute not present, true if form attribute present and set to qualified, false if form attribute present and set to unqualified.

getIdentityConstraints back to summary

getIdentityConstraints	back to summary
public List<XSIdentityConstraint> getIdentityConstraints() Returns all the `XSIdentityConstraint`s in this element decl. Returns:List<XSIdentityConstraint> never null, but can be empty.

public List<XSIdentityConstraint> getIdentityConstraints()

Returns all the XSIdentityConstraints in this element decl.

Returns:List<XSIdentityConstraint>: never null, but can be empty.

getSubstAffiliation	back to summary
public XSElementDecl getSubstAffiliation() Gets the substitution head of this element, if any. Otherwise null.

getSubstitutables	back to summary
public Set<? extends XSElementDecl> getSubstitutables() Returns the element declarations that can substitute this element. IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint. Note that the above clause does NOT check for abstract elements. So abstract elements may still show up in the returned set. Returns:Set<? extends XSElementDecl> nun-null unmodifiable list. The returned list always contains this element decl itself.

getSubstitutables

back to summary

public Set<? extends XSElementDecl> getSubstitutables()

Returns the element declarations that can substitute this element.

IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint.

Note that the above clause does NOT check for abstract elements. So abstract elements may still show up in the returned set.

Returns:Set<? extends XSElementDecl>: nun-null unmodifiable list. The returned list always contains this element decl itself.

getType	back to summary
public XSType getType() Gets the type of this element declaration. Returns:XSType always non-null.

getType

back to summary

public XSType getType()

Gets the type of this element declaration.

Returns:XSType: always non-null.

isAbstract	back to summary
public boolean isAbstract()

isNillable	back to summary
public boolean isNillable()

isSubstitutionDisallowed back to summary

isSubstitutionDisallowed	back to summary
public boolean isSubstitutionDisallowed(int method) Checks the diallowed substitution property of the schema component. IOW, this checks the value of the `block` attribute (plus `blockDefault`). Parameters method:int Possible values are `XSType#EXTENSION`, `XSType.RESTRICTION`, or `XSType.SUBSTITUTION`

public boolean isSubstitutionDisallowed(int method)

Checks the diallowed substitution property of the schema component. IOW, this checks the value of the block attribute (plus blockDefault).

Parameters

method:int: Possible values are XSType#EXTENSION, XSType.RESTRICTION, or XSType.SUBSTITUTION

isSubstitutionExcluded back to summary

isSubstitutionExcluded	back to summary
public boolean isSubstitutionExcluded(int method) Checks the substitution excluded property of the schema component. IOW, this checks the value of the `final` attribute (plus `finalDefault`). Parameters method:int Possible values are `XSType#EXTENSION` or `XSType.RESTRICTION`.

public boolean isSubstitutionExcluded(int method)

Checks the substitution excluded property of the schema component. IOW, this checks the value of the final attribute (plus finalDefault).

Parameters

method:int: Possible values are XSType#EXTENSION or XSType.RESTRICTION.

listSubstitutables back to summary

listSubstitutables	back to summary
public XSElementDecl[] listSubstitutables() Deprecated this method allocates a new array every time, so it could be inefficient when working with a large schema. Use `getSubstitutables()` instead. Returns the element declarations that can substitute this element. IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint. Returns:XSElementDecl[] nun-null valid array. The return value always contains this element decl itself. Annotations @Deprecated

public XSElementDecl[] listSubstitutables()

Deprecated

this method allocates a new array every time, so it could be inefficient when working with a large schema. Use getSubstitutables() instead.

Returns the element declarations that can substitute this element.

IOW, this set returns all the element decls that satisfies the "Substitution Group OK" constraint.

Returns:XSElementDecl[]

nun-null valid array. The return value always contains this element decl itself.

Annotations

@Deprecated

public Interface XSElementDecl

Method Summary

Method Detail