public interface

XSAttributeDeclaration

implements XSObject
org.apache.xerces.xs.XSAttributeDeclaration
Known Indirect Subclasses

Class Overview

The interface represents the Attribute Declaration schema component.

Summary

Public Methods
abstract Object getActualVC()
Value Constraint: Binding specific actual constraint value or null if the value is in error or there is no value constraint.
abstract short getActualVCType()
The actual constraint value built-in datatype, e.g.
abstract XSAnnotation getAnnotation()
An annotation if it exists, otherwise null.
abstract XSObjectList getAnnotations()
A sequence of [annotations] or an empty XSObjectList.
abstract short getConstraintType()
Value constraint: one of VC_NONE, VC_DEFAULT, VC_FIXED.
abstract String getConstraintValue()
Value constraint: The constraint value with respect to the [type definition], otherwise null.
abstract XSComplexTypeDefinition getEnclosingCTDefinition()
The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.
abstract ShortList getItemValueTypes()
In the case the actual constraint value represents a list, i.e.
abstract short getScope()
[scope].
abstract XSSimpleTypeDefinition getTypeDefinition()
[type definition]: A simple type definition.
[Expand]
Inherited Methods
From interface org.apache.xerces.xs.XSObject

Public Methods

public abstract Object getActualVC ()

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

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

public abstract short getActualVCType ()

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 actualValue is null, this method returns UNAVAILABLE_DT.

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

public abstract XSAnnotation getAnnotation ()

An annotation if it exists, otherwise null. If not null then the first [annotation] from the sequence of annotations.

public abstract XSObjectList getAnnotations ()

A sequence of [annotations] or an empty XSObjectList.

public abstract short getConstraintType ()

Value constraint: one of VC_NONE, VC_DEFAULT, VC_FIXED.

public abstract String getConstraintValue ()

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

public abstract XSComplexTypeDefinition getEnclosingCTDefinition ()

The complex type definition for locally scoped declarations (see scope), otherwise null if no such definition exists.

public abstract ShortList getItemValueTypes ()

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.

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

public abstract short getScope ()

[scope]. One of SCOPE_GLOBAL, SCOPE_LOCAL, or SCOPE_ABSENT. If the scope is local, then the enclosingCTDefinition is present.

public abstract XSSimpleTypeDefinition getTypeDefinition ()

[type definition]: A simple type definition.