org.jomc.model

Class InheritanceModel

java.lang.Object

org.jomc.model.InheritanceModel

public class InheritanceModel
extends Object

Inheritance model.

Since:

1.2

Version:

$JOMC: InheritanceModel.java 5043 2015-05-27 07:03:39Z schulte $

Author:

Christian Schulte

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InheritanceModel.Node<T> Inheritance model node.

Constructor Summary

Constructors

Constructor and Description
InheritanceModel(Modules modules) Creates a new InheritanceModel instance.

Method Summary

Methods

Modifier and Type	Method and Description
Set<InheritanceModel.Node<ImplementationReference>>	getCycleNodes(String implementation) Gets a set holding implementation reference nodes of an implementation causing a cycle.
Set<String>	getDependencyNames(String implementation) Gets a set holding the names of all dependencies of an implementation.
Set<InheritanceModel.Node<Dependency>>	getDependencyNodes(String implementation, String name) Gets a set holding effective dependency nodes of an implementation.
Set<String>	getImplementationReferenceIdentifiers(String implementation) Gets a set holding the identifiers of all implementation references of an implementation.
Set<InheritanceModel.Node<ImplementationReference>>	getImplementationReferenceNodes(String implementation, String identifier) Gets a set holding effective implementation reference nodes of an implementation.
Set<QName>	getJaxbElementNames(String implementation) Gets a set holding the qualified names of all XML elements of an implementation.
Set<InheritanceModel.Node<javax.xml.bind.JAXBElement<?>>>	getJaxbElementNodes(String implementation, QName name) Gets a set holding effective JAXB element nodes of an implementation.
Set<String>	getMessageNames(String implementation) Gets a set holding the names of all messages of an implementation.
Set<InheritanceModel.Node<Message>>	getMessageNodes(String implementation, String name) Gets a set holding effective message nodes of an implementation.
Set<String>	getPropertyNames(String implementation) Gets a set holding the names of all properties of an implementation.
Set<InheritanceModel.Node<Property>>	getPropertyNodes(String implementation, String name) Gets a set holding effective property nodes of an implementation.
Set<InheritanceModel.Node<Implementation>>	getSourceNodes(String implementation) Gets a set holding source nodes of an implementation.
Set<String>	getSpecificationReferenceIdentifiers(String implementation) Gets a set holding the identifiers of all specification references of an implementation.
Set<InheritanceModel.Node<SpecificationReference>>	getSpecificationReferenceNodes(String implementation, String identifier) Gets a set holding effective specification reference nodes of an implementation.
Set<QName>	getXmlElementNames(String implementation) Gets a set holding the qualified names of all XML elements of an implementation.
Set<InheritanceModel.Node<Element>>	getXmlElementNodes(String implementation, QName name) Gets a set holding effective XML element nodes of an implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InheritanceModel

public InheritanceModel(Modules modules)

Creates a new InheritanceModel instance.

Parameters:

modules - The modules backing the model.

Throws:

NullPointerException - if modules is null.

See Also:

Modules.clone()

Method Detail

getSourceNodes

public Set<InheritanceModel.Node<Implementation>> getSourceNodes(String implementation)

Gets a set holding source nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get source nodes of.

Returns:

An unmodifiable set holding source nodes of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

See Also:

InheritanceModel.Node.getDescendant()

getCycleNodes

public Set<InheritanceModel.Node<ImplementationReference>> getCycleNodes(String implementation)

Gets a set holding implementation reference nodes of an implementation causing a cycle.

Parameters:

implementation - The identifier of the implementation to get implementation reference nodes causing a cycle of.

Returns:

An unmodifiable set holding implementation reference nodes of the implementation identified by implementation causing a cycle.

Throws:

NullPointerException - if implementation is null.

Since:

1.5

See Also:

InheritanceModel.Node.getPath()

getDependencyNames

public Set<String> getDependencyNames(String implementation)

Gets a set holding the names of all dependencies of an implementation.

Parameters:

implementation - The identifier of the implementation to get the names of all dependencies of.

Returns:

An unmodifiable set holding the names of all dependencies of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getDependencyNodes

public Set<InheritanceModel.Node<Dependency>> getDependencyNodes(String implementation,
                                                        String name)

Gets a set holding effective dependency nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective dependency nodes of.

name - The dependency name to get effective nodes for.

Returns:

An unmodifiable set holding effective dependency nodes matching name of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or name is null.

See Also:

getDependencyNames(java.lang.String)

getImplementationReferenceIdentifiers

public Set<String> getImplementationReferenceIdentifiers(String implementation)

Gets a set holding the identifiers of all implementation references of an implementation.

Parameters:

implementation - The identifier of the implementation to get the identifiers of all implementation references of.

Returns:

An unmodifiable set holding the identifiers of all implementation references of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getImplementationReferenceNodes

public Set<InheritanceModel.Node<ImplementationReference>> getImplementationReferenceNodes(String implementation,
                                                                                  String identifier)

Gets a set holding effective implementation reference nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective implementation reference nodes of.

identifier - The implementation reference identifier to get effective nodes for.

Returns:

An unmodifiable set holding effective implementation reference nodes matching identifier of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or identifier is null.

See Also:

getImplementationReferenceIdentifiers(java.lang.String)

getJaxbElementNames

public Set<QName> getJaxbElementNames(String implementation)

Gets a set holding the qualified names of all XML elements of an implementation.

Parameters:

implementation - The identifier of the implementation to get the qualified names of all XML elements of.

Returns:

An unmodifiable set holding the qualified names of all XML elements of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getJaxbElementNodes

public Set<InheritanceModel.Node<javax.xml.bind.JAXBElement<?>>> getJaxbElementNodes(String implementation,
                                                                            QName name)

Gets a set holding effective JAXB element nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective JAXB element nodes of.

name - The qualified JAXB element name to get effective nodes for.

Returns:

An unmodifiable set holding effective JAXB element nodes matching name of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or name is null.

See Also:

getJaxbElementNames(java.lang.String)

getMessageNames

public Set<String> getMessageNames(String implementation)

Gets a set holding the names of all messages of an implementation.

Parameters:

implementation - The identifier of the implementation to get the names of all messages of.

Returns:

An unmodifiable set holding the names of all messages of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getMessageNodes

public Set<InheritanceModel.Node<Message>> getMessageNodes(String implementation,
                                                  String name)

Gets a set holding effective message nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective message nodes of.

name - The message name to get effective nodes for.

Returns:

An unmodifiable set holding effective message nodes matching name of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or name is null.

See Also:

getMessageNames(java.lang.String)

getPropertyNames

public Set<String> getPropertyNames(String implementation)

Gets a set holding the names of all properties of an implementation.

Parameters:

implementation - The identifier of the implementation to get the names of all properties of.

Returns:

An unmodifiable set holding the names of all properties of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getPropertyNodes

public Set<InheritanceModel.Node<Property>> getPropertyNodes(String implementation,
                                                    String name)

Gets a set holding effective property nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective property nodes of.

name - The property name to get effective nodes for.

Returns:

An unmodifiable set holding effective property nodes matching name of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or name is null.

See Also:

getPropertyNames(java.lang.String)

getSpecificationReferenceIdentifiers

public Set<String> getSpecificationReferenceIdentifiers(String implementation)

Gets a set holding the identifiers of all specification references of an implementation.

Parameters:

implementation - The identifier of the implementation to get the identifiers of all specification references of.

Returns:

An unmodifiable set holding the identifiers of all specification references of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getSpecificationReferenceNodes

public Set<InheritanceModel.Node<SpecificationReference>> getSpecificationReferenceNodes(String implementation,
                                                                                String identifier)

Gets a set holding effective specification reference nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective specification reference nodes of.

identifier - The specification reference identifier to get effective nodes for.

Returns:

An unmodifiable set holding effective specification reference nodes matching identifier of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or identifier is null.

See Also:

getSpecificationReferenceIdentifiers(java.lang.String)

getXmlElementNames

public Set<QName> getXmlElementNames(String implementation)

Gets a set holding the qualified names of all XML elements of an implementation.

Parameters:

implementation - The identifier of the implementation to get the qualified names of all XML elements of.

Returns:

An unmodifiable set holding the qualified names of all XML elements of the implementation identified by implementation.

Throws:

NullPointerException - if implementation is null.

getXmlElementNodes

public Set<InheritanceModel.Node<Element>> getXmlElementNodes(String implementation,
                                                     QName name)

Gets a set holding effective XML element nodes of an implementation.

Parameters:

implementation - The identifier of the implementation to get effective XML element nodes of.

name - The qualified XML element name to get effective nodes for.

Returns:

An unmodifiable set holding effective XML element nodes matching name of the implementation identified by implementation.

Throws:

NullPointerException - if implementation or name is null.

See Also:

getXmlElementNames(java.lang.String)