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

Method Summary

Modifier and Type	Method and Description
public <T> T	apply(XSSimpleTypeFunction<T> function)
public XSListSimpleType	asList()
public XSRestrictionSimpleType	asRestriction()
public XSUnionSimpleType	asUnion()
public XSListSimpleType	Returns: otherwise return null getBaseListType() Gets the nearest ancestor `XSListSimpleType` (including itself) if the variety of this type is `list`.
public XSUnionSimpleType	Returns: otherwise return null getBaseUnionType() Gets the nearest ancestor `XSUnionSimpleType` (including itself) if the variety of this type is `union`.
public XSFacet	Returns: If this datatype has a facet of the given name, return that object. If the facet is not specified anywhere in its derivation chain, null will be returned. getFacet(String name) Gets the effective facet object of the given name.
public List<XSFacet>	Returns: can be empty but never null. getFacets(String name) For multi-valued facets (enumeration and pattern), obtain all values.
public XSSimpleType	Returns: null otherwise. getPrimitiveType() Gets the ancestor primitive if this type is `atomic`.
public XSSimpleType	Returns: null if this component has not been redefined. getRedefinedBy() Redeclares com.sun.xml.xsom.XSType.getRedefinedBy. If this is redefined by another simple type, return that component.
public XSSimpleType	Returns: null if this is xs:anySimpleType. Otherwise non-null. getSimpleBaseType() Gets the base type as XSSimpleType.
public XSVariety	getVariety() Gets the variety of this simple type.
public boolean	Returns: true if the type is marked final. isFinal(XSVariety v) Returns true if this type definition is marked as 'final' with respect to the given `XSVariety`.
public boolean	isList() Returns true if `this instanceof XSListSimpleType`.
public boolean	isPrimitive() Returns true if this is a primitive built-in simple type (that directly derives from xs:anySimpleType, by definition.)
public boolean	isRestriction() Returns true if `this instanceof XSRestrictionSimpleType`.
public boolean	isUnion() Returns true if `this instanceof XSUnionSimpleType`.
public void	visit(XSSimpleTypeVisitor visitor)

Inherited from com.sun.xml.xsom.XSContentType:: apply asEmpty asParticle asSimpleType visit
Inherited from com.sun.xml.xsom.XSType:: asComplexType asSimpleType getBaseType getDerivationMethod getRedefinedCount isComplexType isDerivedFrom isSimpleType listSubstitutables

Method Detail

apply	back to summary
public <T> T apply(XSSimpleTypeFunction<T> function)

asList	back to summary
public XSListSimpleType asList()

asRestriction	back to summary
public XSRestrictionSimpleType asRestriction()

asUnion	back to summary
public XSUnionSimpleType asUnion()

getBaseListType back to summary

getBaseListType	back to summary
public XSListSimpleType getBaseListType() Gets the nearest ancestor `XSListSimpleType` (including itself) if the variety of this type is `list`. Returns:XSListSimpleType otherwise return null

public XSListSimpleType getBaseListType()

Gets the nearest ancestor XSListSimpleType (including itself) if the variety of this type is list.

Returns:XSListSimpleType: otherwise return null

getBaseUnionType back to summary

getBaseUnionType	back to summary
public XSUnionSimpleType getBaseUnionType() Gets the nearest ancestor `XSUnionSimpleType` (including itself) if the variety of this type is `union`. Returns:XSUnionSimpleType otherwise return null

public XSUnionSimpleType getBaseUnionType()

Gets the nearest ancestor XSUnionSimpleType (including itself) if the variety of this type is union.

Returns:XSUnionSimpleType: otherwise return null

getFacet	back to summary
public XSFacet getFacet(String name) Gets the effective facet object of the given name. For example, if a simple type "foo" is derived from xs:string by restriction with the "maxLength" facet and another simple type "bar" is derived from "foo" by restriction with another "maxLength" facet, this method will return the latter one, because that is the most restrictive, effective facet. For those facets that can have multiple values (pattern facets and enumeration facets), this method will return only the first one. Todo allow clients to access all of them by some means. Returns:XSFacet If this datatype has a facet of the given name, return that object. If the facet is not specified anywhere in its derivation chain, null will be returned.

getFacet

back to summary

public XSFacet getFacet(String name)

Gets the effective facet object of the given name.

For example, if a simple type "foo" is derived from xs:string by restriction with the "maxLength" facet and another simple type "bar" is derived from "foo" by restriction with another "maxLength" facet, this method will return the latter one, because that is the most restrictive, effective facet.

For those facets that can have multiple values (pattern facets and enumeration facets), this method will return only the first one.

Todo

allow clients to access all of them by some means.

Returns:XSFacet: If this datatype has a facet of the given name, return that object. If the facet is not specified anywhere in its derivation chain, null will be returned.

getFacets back to summary

getFacets	back to summary
public List<XSFacet> getFacets(String name) For multi-valued facets (enumeration and pattern), obtain all values. Returns:List<XSFacet> can be empty but never null. See Also `getFacet(String)`

public List<XSFacet> getFacets(String name)

For multi-valued facets (enumeration and pattern), obtain all values.

Returns:List<XSFacet>: can be empty but never null.
See Also: getFacet(String)

getPrimitiveType back to summary

getPrimitiveType	back to summary
public XSSimpleType getPrimitiveType() Gets the ancestor primitive if this type is `atomic`. Returns:XSSimpleType null otherwise.

public XSSimpleType getPrimitiveType()

Gets the ancestor primitive if this type is atomic.

Returns:XSSimpleType: null otherwise.

getRedefinedBy	back to summary
public XSSimpleType getRedefinedBy() Redeclares com.sun.xml.xsom.XSType.getRedefinedBy. If this is redefined by another simple type, return that component. Returns:XSSimpleType null if this component has not been redefined.

getRedefinedBy

back to summary

public XSSimpleType getRedefinedBy()

Redeclares com.sun.xml.xsom.XSType.getRedefinedBy.

If this is redefined by another simple type, return that component.

Returns:XSSimpleType: null if this component has not been redefined.

getSimpleBaseType back to summary

getSimpleBaseType	back to summary
public XSSimpleType getSimpleBaseType() Gets the base type as XSSimpleType. Equivalent to `(XSSimpleType)getBaseType()` Since this is a simple type, we know that the base type is also a simple type. The only exception is xs:anySimpleType, which has xs:anyType as the base type. Returns:XSSimpleType null if this is xs:anySimpleType. Otherwise non-null.

public XSSimpleType getSimpleBaseType()

Gets the base type as XSSimpleType. Equivalent to (XSSimpleType)getBaseType() Since this is a simple type, we know that the base type is also a simple type. The only exception is xs:anySimpleType, which has xs:anyType as the base type.

Returns:XSSimpleType: null if this is xs:anySimpleType. Otherwise non-null.

getVariety	back to summary
public XSVariety getVariety() Gets the variety of this simple type.

isFinal back to summary

isFinal	back to summary
public boolean isFinal(XSVariety v) Returns true if this type definition is marked as 'final' with respect to the given `XSVariety`. Returns:boolean true if the type is marked final.

public boolean isFinal(XSVariety v)

Returns true if this type definition is marked as 'final' with respect to the given XSVariety.

Returns:boolean: true if the type is marked final.

isList	back to summary
public boolean isList() Returns true if `this instanceof XSListSimpleType`.

isPrimitive	back to summary
public boolean isPrimitive() Returns true if this is a primitive built-in simple type (that directly derives from xs:anySimpleType, by definition.)

isRestriction	back to summary
public boolean isRestriction() Returns true if `this instanceof XSRestrictionSimpleType`.

isUnion	back to summary
public boolean isUnion() Returns true if `this instanceof XSUnionSimpleType`.

visit	back to summary
public void visit(XSSimpleTypeVisitor visitor)

public Interface XSSimpleType

Field Summary

Method Summary

Method Detail