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

Method Summary

Modifier and Type	Method and Description
public <T> T	apply(XSFunction<T> function) Accepts a functor.
public XSAnnotation	getAnnotation() Gets the annotation associated to this component, if any.
public XSAnnotation	Returns: null if `createIfNotExist==false` and annotation didn't exist. Otherwise non-null. getAnnotation(boolean true to create a new `XSAnnotation` if it doesn't exist already. false to make this method behavel like `getAnnotation()`. createIfNotExist) Works like `getAnnotation()`, but allow a new empty `XSAnnotation` to be created if not exist.
public String	getForeignAttribute(String nsUri, String localName) Gets the foreign attribute of the given name, or null if not found.
public List<? extends ForeignAttributes>	Returns: can be an empty list but never be null. getForeignAttributes() Gets the foreign attributes on this schema component.
public Locator	getLocator() Gets the locator that indicates the source location where this component is created from, or null if no information is available.
public XSSchema	getOwnerSchema() Gets a reference to the `XSSchema` object to which this component belongs.
public XSSchemaSet	getRoot() Gets the root schema set that includes this component.
public SchemaDocument	Returns: null for components that are built-in to XML Schema, such as anyType, or "empty" `XSContentType`. This method also returns null for `XSSchema`. For all other user-defined components this method returns non-null, even if they are local. getSourceDocument() Gets the `SchemaDocument` that indicates which document this component was defined in.
public Collection<XSComponent>	Returns: Can be empty but never null. select(String Schema component designator. See `SCD` for more details. scd, NamespaceContext The namespace context in which SCD is evaluated. Cannot be null. nsContext) Evaluates a schema component designator against this schema component and returns the resulting schema components.
public XSComponent	Returns: null if the SCD didn't match anything. If the SCD matched more than one node, the first one will be returned. selectSingle(String Schema component designator. See `SCD` for more details. scd, NamespaceContext The namespace context in which SCD is evaluated. Cannot be null. nsContext) Evaluates a schema component designator against this schema component and returns the first resulting schema component.
public void	visit(XSVisitor visitor) Accepts a visitor.

Method Detail

apply	back to summary
public <T> T apply(XSFunction<T> function) Accepts a functor.

getAnnotation	back to summary
public XSAnnotation getAnnotation() Gets the annotation associated to this component, if any.

getAnnotation back to summary

getAnnotation	back to summary
public XSAnnotation getAnnotation(boolean createIfNotExist) Works like `getAnnotation()`, but allow a new empty `XSAnnotation` to be created if not exist. Parameters createIfNotExist:boolean true to create a new `XSAnnotation` if it doesn't exist already. false to make this method behavel like `getAnnotation()`. Returns:XSAnnotation null if `createIfNotExist==false` and annotation didn't exist. Otherwise non-null.

public XSAnnotation getAnnotation(boolean createIfNotExist)

Works like getAnnotation(), but allow a new empty XSAnnotation to be created if not exist.

Parameters

createIfNotExist:boolean: true to create a new XSAnnotation if it doesn't exist already. false to make this method behavel like getAnnotation().

Returns:XSAnnotation

null if createIfNotExist==false and annotation didn't exist. Otherwise non-null.

getForeignAttribute back to summary

getForeignAttribute	back to summary
public String getForeignAttribute(String nsUri, String localName) Gets the foreign attribute of the given name, or null if not found. If multiple occurrences of the same attribute is found, this method returns the first one. See Also `getForeignAttributes()`

public String getForeignAttribute(String nsUri, String localName)

Gets the foreign attribute of the given name, or null if not found.

If multiple occurrences of the same attribute is found, this method returns the first one.

See Also: getForeignAttributes()

getForeignAttributes back to summary

getForeignAttributes	back to summary
public List<? extends ForeignAttributes> getForeignAttributes() Gets the foreign attributes on this schema component. In general, a schema component may match multiple elements in a schema document, and those elements can individually carry foreign attributes. This method returns a list of `ForeignAttributes`, where each `ForeignAttributes` object represent foreign attributes on one element. Returns:List<? extends ForeignAttributes> can be an empty list but never be null.

public List<? extends ForeignAttributes> getForeignAttributes()

Gets the foreign attributes on this schema component.

In general, a schema component may match multiple elements in a schema document, and those elements can individually carry foreign attributes.

This method returns a list of ForeignAttributes, where each ForeignAttributes object represent foreign attributes on one element.

Returns:List<? extends ForeignAttributes>: can be an empty list but never be null.

getLocator	back to summary
public Locator getLocator() Gets the locator that indicates the source location where this component is created from, or null if no information is available.

getOwnerSchema back to summary

getOwnerSchema	back to summary
public XSSchema getOwnerSchema() Gets a reference to the `XSSchema` object to which this component belongs. In case of `XSEmpty` component, this method returns null since there is no owner component.

public XSSchema getOwnerSchema()

Gets a reference to the XSSchema object to which this component belongs.

In case of XSEmpty component, this method returns null since there is no owner component.

getRoot back to summary

getRoot	back to summary
public XSSchemaSet getRoot() Gets the root schema set that includes this component. In case of `XSEmpty` component, this method returns null since there is no owner component.

public XSSchemaSet getRoot()

Gets the root schema set that includes this component.

In case of XSEmpty component, this method returns null since there is no owner component.

getSourceDocument back to summary

getSourceDocument	back to summary
public SchemaDocument getSourceDocument() Gets the `SchemaDocument` that indicates which document this component was defined in. Returns:SchemaDocument null for components that are built-in to XML Schema, such as anyType, or "empty" `XSContentType`. This method also returns null for `XSSchema`. For all other user-defined components this method returns non-null, even if they are local.

public SchemaDocument getSourceDocument()

Gets the SchemaDocument that indicates which document this component was defined in.

Returns:SchemaDocument: null for components that are built-in to XML Schema, such as anyType, or "empty" XSContentType. This method also returns null for XSSchema. For all other user-defined components this method returns non-null, even if they are local.

select back to summary

select	back to summary
public Collection<XSComponent> select(String scd, NamespaceContext nsContext) Evaluates a schema component designator against this schema component and returns the resulting schema components. Parameters scd:String Schema component designator. See `SCD` for more details. nsContext:NamespaceContext The namespace context in which SCD is evaluated. Cannot be null. Returns:Collection<XSComponent> Can be empty but never null. Exceptions IllegalArgumentException: if SCD is syntactically incorrect.

public Collection<XSComponent> select(String scd, NamespaceContext nsContext)

Evaluates a schema component designator against this schema component and returns the resulting schema components.

Parameters

scd:String: Schema component designator. See SCD for more details.
nsContext:NamespaceContext: The namespace context in which SCD is evaluated. Cannot be null.

Returns:Collection<XSComponent>

Can be empty but never null.

Exceptions

IllegalArgumentException:: if SCD is syntactically incorrect.

selectSingle back to summary

selectSingle	back to summary
public XSComponent selectSingle(String scd, NamespaceContext nsContext) Evaluates a schema component designator against this schema component and returns the first resulting schema component. Parameters scd:String Schema component designator. See `SCD` for more details. nsContext:NamespaceContext The namespace context in which SCD is evaluated. Cannot be null. Returns:XSComponent null if the SCD didn't match anything. If the SCD matched more than one node, the first one will be returned. Exceptions IllegalArgumentException: if SCD is syntactically incorrect.

public XSComponent selectSingle(String scd, NamespaceContext nsContext)

Evaluates a schema component designator against this schema component and returns the first resulting schema component.

Parameters

scd:String: Schema component designator. See SCD for more details.
nsContext:NamespaceContext: The namespace context in which SCD is evaluated. Cannot be null.

Returns:XSComponent

null if the SCD didn't match anything. If the SCD matched more than one node, the first one will be returned.

Exceptions

IllegalArgumentException:: if SCD is syntactically incorrect.

visit	back to summary
public void visit(XSVisitor visitor) Accepts a visitor.

public Interface XSComponent

Method Summary

Method Detail