org.jomc.model
Class InheritanceModel.Node<T>

java.lang.Object
  org.jomc.model.InheritanceModel.Node<T>

Type Parameters:

T - The type of the model object of the node.

Enclosing class:

InheritanceModel

public static class InheritanceModel.Node<T>
extends Object

Inheritance model node.

Since:

1.2

Version:

$JOMC: InheritanceModel.java 4138 2011-12-27 18:10:02Z schulte2005 $

Author:

Christian Schulte

Constructor Summary

InheritanceModel.Node(Implementation implementation, Specification specification, Implementation classDeclaration, InheritanceModel.Node<Implementation> descendant, T modelObject, boolean finalNode, boolean overrideNode)
Creates a new Node instance.

Method Summary

Implementation	getClassDeclaration() Gets the class declaration the node originates from.
InheritanceModel.Node<Implementation>	getDescendant() Gets the direct descendant node of the node.
Implementation	getImplementation() Gets the implementation the node originates from.
T	getModelObject() Gets the model object of the node.
Set<InheritanceModel.Node<T>>	getOverriddenNodes() Gets a set of nodes overridden by the node.
List<InheritanceModel.Node<Implementation>>	getPath() Gets the path to the node.
Specification	getSpecification() Gets the specification the node originates from.
boolean	isFinal() Gets a flag indicating the node is the final node in an inheritance hierarchy.
boolean	isOverride() Gets a flag indicating the node is intended to override an ancestor node.

Methods inherited from class java.lang.Object

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

Constructor Detail

InheritanceModel.Node

public InheritanceModel.Node(Implementation implementation,
                             Specification specification,
                             Implementation classDeclaration,
                             InheritanceModel.Node<Implementation> descendant,
                             T modelObject,
                             boolean finalNode,
                             boolean overrideNode)

Creates a new Node instance.

Parameters:

implementation - The implementation the node originates from.

specification - The specification the node originates from or null.

classDeclaration - The class declaration the node originates from or null.

descendant - The direct descendant node of the node or null.

modelObject - The model object of the node.

finalNode - true, if the node is the final node in an inheritance hierarchy; false, else.

overrideNode - true, if the node is intended to override an ancestor node; false, else.

Method Detail

getImplementation

public final Implementation getImplementation()

Gets the implementation the node originates from.

Returns:

The implementation the node originates from.

getSpecification

public final Specification getSpecification()

Gets the specification the node originates from.

Returns:

The specification the node originates from or null, if the node does not originate from a specification.

getClassDeclaration

public final Implementation getClassDeclaration()

Gets the class declaration the node originates from.

Returns:

The class declaration the node originates from or null, if the node does not originate from a class declaration.

getDescendant

public final InheritanceModel.Node<Implementation> getDescendant()

Gets the direct descendant node of the node.

Returns:

The direct descendant node of the node or null.

See Also:

InheritanceModel.getSourceNodes(java.lang.String)

getModelObject

public final T getModelObject()

Gets the model object of the node.

Returns:

The model object of the node.

isFinal

public final boolean isFinal()

Gets a flag indicating the node is the final node in an inheritance hierarchy.

Returns:

true, if the node is the final node in an inheritance hierarchy; false, else.

isOverride

public final boolean isOverride()

Gets a flag indicating the node is intended to override an ancestor node.

Returns:

true, if the node is intended to override an ancestor; false else.

getOverriddenNodes

public final Set<InheritanceModel.Node<T>> getOverriddenNodes()

Gets a set of nodes overridden by the node.

Returns:

An unmodifiable set holding nodes overridden by the node.

getPath

public final List<InheritanceModel.Node<Implementation>> getPath()

Gets the path to the node.

Returns:

An unmodifiable list holding path elements.