OpenJDK 27 · com.sun.org.apache.xerces.internal.xs.XSElementDeclaration

Method Summary

Modifier and Type	Method and Description
public boolean	getAbstract() {abstract} A boolean.
public Object	getActualVC() Deprecated Use getValueConstraintValue().getActualValue() instead Value Constraint: Binding specific actual constraint value or `null` if the value is in error or there is no value constraint.
public short	getActualVCType() Deprecated Use getValueConstraintValue().getActualValueType() instead The actual constraint value built-in datatype, e.g. `STRING_DT, SHORT_DT`.
public XSAnnotation	getAnnotation() An annotation if it exists, otherwise `null`.
public XSObjectList	getAnnotations() A sequence of [annotations] or an empty `XSObjectList`.
public short	getConstraintType() [Value constraint]: one of `VC_NONE, VC_DEFAULT, VC_FIXED`.
public String	getConstraintValue() Deprecated Use getValueConstraintValue().getNormalizedValue() instead [Value constraint]: the constraint value with respect to the [type definition], otherwise `null`.
public short	getDisallowedSubstitutions() [disallowed substitutions]: the returned value is a bit combination of the subset of { `DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION` } corresponding to substitutions disallowed by this `XSElementDeclaration` or `DERIVATION_NONE`.
public XSComplexTypeDefinition	getEnclosingCTDefinition() The complex type definition for locally scoped declarations (see `scope`), otherwise `null` if no such definition exists.
public XSNamedMap	getIdentityConstraints() identity-constraint definitions: a set of constraint definitions if it exists, otherwise an empty `XSNamedMap`.
public ShortList	getItemValueTypes() Deprecated Use getValueConstraintValue().getListValueTypes() instead In the case the actual constraint value represents a list, i.e. the `actualValueType` is `LIST_DT`, the returned array consists of one type kind which represents the itemType.
public boolean	getNillable() If nillable is true, then an element may also be valid if it carries the namespace qualified attribute with local name `nil` from namespace `http://www.w3.org/2001/XMLSchema-instance` and value `true` (xsi:nil) even if it has no text or element content despite a `content type` which would otherwise require content.
public short	getScope() [scope].
public XSElementDeclaration	getSubstitutionGroupAffiliation() [substitution group affiliation]: a top-level element definition if it exists, otherwise `null`.
public short	getSubstitutionGroupExclusions() [substitution group exclusions]: the returned value is a bit combination of the subset of { `DERIVATION_EXTENSION, DERIVATION_RESTRICTION`} or `DERIVATION_NONE`.
public XSTypeDefinition	getTypeDefinition() [type definition]: either a simple type definition or a complex type definition.
public XSValue	getValueConstraintValue() The actual value of the default or fixed value constraint.
public boolean	Returns: True if `disallowed` is a part of the substitution group exclusion subset. isDisallowedSubstitution(short { `DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION` } or `DERIVATION_NONE`. Represents a block set for the element. disallowed) Convenience method that checks if `disallowed` is a disallowed substitution for this element declaration.
public boolean	Returns: True if `exclusion` is a part of the substitution group exclusion subset. isSubstitutionGroupExclusion(short `DERIVATION_EXTENSION, DERIVATION_RESTRICTION` or `DERIVATION_NONE`. Represents final set for the element. exclusion) Convenience method that checks if `exclusion` is a substitution group exclusion for this element declaration.

Method Detail

getAbstract	back to summary
public boolean getAbstract() {abstract} A boolean.

getActualVC back to summary

getActualVC	back to summary
public Object getActualVC() throws XSException Deprecated Use getValueConstraintValue().getActualValue() instead Value Constraint: Binding specific actual constraint value or `null` if the value is in error or there is no value constraint. Annotations @Deprecated Exceptions XSException: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public Object getActualVC() throws XSException

Deprecated

Use getValueConstraintValue().getActualValue() instead

Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.

Annotations

@Deprecated

Exceptions

XSException:: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getActualVCType back to summary

getActualVCType	back to summary
public short getActualVCType() throws XSException Deprecated Use getValueConstraintValue().getActualValueType() instead The actual constraint value built-in datatype, e.g. `STRING_DT, SHORT_DT`. If the type definition of this value is a list type definition, this method returns `LIST_DT`. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns `LISTOFUNION_DT`. To query the actual constraint value of the list or list of union type definitions use `itemValueTypes`. If the `actualNormalizedValue` is `null`, this method returns `UNAVAILABLE_DT`. Annotations @Deprecated Exceptions XSException: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public short getActualVCType() throws XSException

Deprecated

Use getValueConstraintValue().getActualValueType() instead

The actual constraint value built-in datatype, e.g. STRING_DT, SHORT_DT. If the type definition of this value is a list type definition, this method returns LIST_DT. If the type definition of this value is a list type definition whose item type is a union type definition, this method returns LISTOFUNION_DT. To query the actual constraint value of the list or list of union type definitions use itemValueTypes. If the actualNormalizedValue is null, this method returns UNAVAILABLE_DT.

Annotations

@Deprecated

Exceptions

XSException:: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getAnnotation	back to summary
public XSAnnotation getAnnotation() An annotation if it exists, otherwise `null`. If not null then the first [annotation] from the sequence of annotations.

getAnnotations	back to summary
public XSObjectList getAnnotations() A sequence of [annotations] or an empty `XSObjectList`.

getConstraintType	back to summary
public short getConstraintType() [Value constraint]: one of `VC_NONE, VC_DEFAULT, VC_FIXED`.

getConstraintValue back to summary

getConstraintValue	back to summary
public String getConstraintValue() Deprecated Use getValueConstraintValue().getNormalizedValue() instead [Value constraint]: the constraint value with respect to the [type definition], otherwise `null`. Annotations @Deprecated

public String getConstraintValue()

Deprecated

Use getValueConstraintValue().getNormalizedValue() instead

[Value constraint]: the constraint value with respect to the [type definition], otherwise null.

Annotations

@Deprecated

getDisallowedSubstitutions	back to summary
public short getDisallowedSubstitutions() [disallowed substitutions]: the returned value is a bit combination of the subset of { `DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION` } corresponding to substitutions disallowed by this `XSElementDeclaration` or `DERIVATION_NONE`.

getEnclosingCTDefinition	back to summary
public XSComplexTypeDefinition getEnclosingCTDefinition() The complex type definition for locally scoped declarations (see `scope`), otherwise `null` if no such definition exists.

getIdentityConstraints	back to summary
public XSNamedMap getIdentityConstraints() identity-constraint definitions: a set of constraint definitions if it exists, otherwise an empty `XSNamedMap`.

getItemValueTypes back to summary

getItemValueTypes	back to summary
public ShortList getItemValueTypes() throws XSException Deprecated Use getValueConstraintValue().getListValueTypes() instead In the case the actual constraint value represents a list, i.e. the `actualValueType` is `LIST_DT`, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e. `LISTOFUNION_DT`, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, see `ItemPSVI.itemValueTypes`. Annotations @Deprecated Exceptions XSException: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

public ShortList getItemValueTypes() throws XSException

Deprecated

Use getValueConstraintValue().getListValueTypes() instead

In the case the actual constraint value represents a list, i.e. the actualValueType is LIST_DT, the returned array consists of one type kind which represents the itemType. If the actual constraint value represents a list type definition whose item type is a union type definition, i.e. LISTOFUNION_DT, for each actual constraint value in the list the array contains the corresponding memberType kind. For examples, see ItemPSVI.itemValueTypes.

Annotations

@Deprecated

Exceptions

XSException:: NOT_SUPPORTED_ERR: Raised if the implementation does not support this method.

getNillable	back to summary
public boolean getNillable() If nillable is true, then an element may also be valid if it carries the namespace qualified attribute with local name `nil` from namespace `http://www.w3.org/2001/XMLSchema-instance` and value `true` (xsi:nil) even if it has no text or element content despite a `content type` which would otherwise require content.

getScope	back to summary
public short getScope() [scope]. One of `SCOPE_GLOBAL`, `SCOPE_LOCAL`, or `SCOPE_ABSENT`. If the scope is local, then the `enclosingCTDefinition` is present.

getSubstitutionGroupAffiliation	back to summary
public XSElementDeclaration getSubstitutionGroupAffiliation() [substitution group affiliation]: a top-level element definition if it exists, otherwise `null`.

getSubstitutionGroupExclusions	back to summary
public short getSubstitutionGroupExclusions() [substitution group exclusions]: the returned value is a bit combination of the subset of { `DERIVATION_EXTENSION, DERIVATION_RESTRICTION`} or `DERIVATION_NONE`.

getTypeDefinition	back to summary
public XSTypeDefinition getTypeDefinition() [type definition]: either a simple type definition or a complex type definition.

getValueConstraintValue	back to summary
public XSValue getValueConstraintValue() The actual value of the default or fixed value constraint.

isDisallowedSubstitution back to summary

isDisallowedSubstitution	back to summary
public boolean isDisallowedSubstitution(short disallowed) Convenience method that checks if `disallowed` is a disallowed substitution for this element declaration. Parameters disallowed:short { `DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION` } or `DERIVATION_NONE`. Represents a block set for the element. Returns:boolean True if `disallowed` is a part of the substitution group exclusion subset.

public boolean isDisallowedSubstitution(short disallowed)

Convenience method that checks if disallowed is a disallowed substitution for this element declaration.

Parameters

disallowed:short: { DERIVATION_SUBSTITUTION, DERIVATION_EXTENSION, DERIVATION_RESTRICTION } or DERIVATION_NONE. Represents a block set for the element.

Returns:boolean

True if disallowed is a part of the substitution group exclusion subset.

isSubstitutionGroupExclusion back to summary

isSubstitutionGroupExclusion	back to summary
public boolean isSubstitutionGroupExclusion(short exclusion) Convenience method that checks if `exclusion` is a substitution group exclusion for this element declaration. Parameters exclusion:short `DERIVATION_EXTENSION, DERIVATION_RESTRICTION` or `DERIVATION_NONE`. Represents final set for the element. Returns:boolean True if `exclusion` is a part of the substitution group exclusion subset.

public boolean isSubstitutionGroupExclusion(short exclusion)

Convenience method that checks if exclusion is a substitution group exclusion for this element declaration.

Parameters

exclusion:short: DERIVATION_EXTENSION, DERIVATION_RESTRICTION or DERIVATION_NONE. Represents final set for the element.

Returns:boolean

True if exclusion is a part of the substitution group exclusion subset.

public Interface XSElementDeclaration

Method Summary

Method Detail