com.sun.xml.ws.policy.sourcemodel

Class ModelNode

java.lang.Object

com.sun.xml.ws.policy.sourcemodel.ModelNode

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<ModelNode>

public final class ModelNode
extends java.lang.Object
implements java.lang.Iterable<ModelNode>, java.lang.Cloneable

The general representation of a single node within a PolicySourceModel instance. The model node is created via factory methods of the PolicySourceModel instance. It may also hold AssertionData instance in case its type is ModelNode.Type.ASSERTION.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelNode.Type Policy source model node type enumeration

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.LinkedList<ModelNode>	children
private static PolicyLogger	LOGGER
private AssertionData	nodeData
private PolicySourceModel	parentModel
private ModelNode	parentNode
private PolicyReferenceData	referenceData
private PolicySourceModel	referencedModel
private ModelNode.Type	type
private java.util.Collection<ModelNode>	unmodifiableViewOnContent

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ModelNode(ModelNode.Type type, PolicySourceModel parentModel)
private	ModelNode(ModelNode.Type type, PolicySourceModel parentModel, AssertionData data)
private	ModelNode(PolicySourceModel parentModel, PolicyReferenceData data)

Method Summary

Modifier and Type	Method and Description
private boolean	addChild(ModelNode child) Appends the specified child node to the end of the children list of this node and sets it's parent to reference this node.
private void	checkCreateChildOperationSupportForType(ModelNode.Type type)
int	childrenSize() Returns the number of child policy source model nodes.
protected ModelNode	clone()
ModelNode	createChildAllNode() Factory method that creates new policy source model node as specified by a factory method name and input parameters.
ModelNode	createChildAssertionNode() Factory method that creates new policy source model node as specified by a factory method name and input parameters.
ModelNode	createChildAssertionNode(AssertionData nodeData) Factory method that creates new policy source model node as specified by a factory method name and input parameters.
ModelNode	createChildAssertionParameterNode() Factory method that creates new policy source model node as specified by a factory method name and input parameters.
(package private) ModelNode	createChildAssertionParameterNode(AssertionData nodeData) Factory method that creates new policy source model node as specified by a factory method name and input parameters.
ModelNode	createChildExactlyOneNode() Factory method that creates new policy source model node as specified by a factory method name and input parameters.
ModelNode	createChildPolicyNode() Factory method that creates new policy source model node as specified by a factory method name and input parameters.
(package private) ModelNode	createChildPolicyReferenceNode(PolicyReferenceData referenceData) Factory method that creates new policy source model node as specified by a factory method name and input parameters.
(package private) static ModelNode	createRootPolicyNode(PolicySourceModel model) The factory method creates and initializes the POLICY model node and sets it's parent model reference to point to the model supplied as an input parameter.
boolean	equals(java.lang.Object obj) An Object.equals(Object obj) method override.
(package private) java.util.Collection<ModelNode>	getChildren()
AssertionData	getNodeData() Returns the data for this policy source model node (if any).
PolicySourceModel	getParentModel() Returns the parent policy source model that contains this model node.
ModelNode	getParentNode() Returns the parent referenced by this policy source model node.
(package private) PolicyReferenceData	getPolicyReferenceData() Returns the policy reference data for this policy source model node.
(package private) PolicyReferenceData	getReferenceData()
(package private) PolicySourceModel	getReferencedModel()
ModelNode.Type	getType() Returns the type of this policy source model node.
boolean	hasChildren() Returns true if the node has at least one child node.
int	hashCode() An Object.hashCode() method override.
(package private) boolean	isDomainSpecific() The method specifies whether the model node instance represents assertion related node, it means whether its type is 'ASSERTION' or 'ASSERTION_PARAMETER_NODE'.
java.util.Iterator<ModelNode>	iterator() Iterates through all child nodes.
AssertionData	setOrReplaceNodeData(AssertionData newData) The method may be used to set or replace assertion data set for this node.
(package private) void	setParentModel(PolicySourceModel model) Sets the parent model reference on the node and its children.
(package private) void	setReferencedModel(PolicySourceModel model)
java.lang.String	toString() Returns a string representation of the object.
java.lang.StringBuffer	toString(int indentLevel, java.lang.StringBuffer buffer) A helper method that appends indented string representation of this instance to the input string buffer.
private void	updateParentModelReference(PolicySourceModel model) The method updates the parentModel reference on current model node instance and all of it's children

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOGGER

private static final PolicyLogger LOGGER

children

private java.util.LinkedList<ModelNode> children

unmodifiableViewOnContent

private java.util.Collection<ModelNode> unmodifiableViewOnContent

type

private final ModelNode.Type type

parentNode

private ModelNode parentNode

parentModel

private PolicySourceModel parentModel

referenceData

private PolicyReferenceData referenceData

referencedModel

private PolicySourceModel referencedModel

nodeData

private AssertionData nodeData

Constructor Detail

ModelNode

private ModelNode(ModelNode.Type type,
                  PolicySourceModel parentModel)

ModelNode

private ModelNode(ModelNode.Type type,
                  PolicySourceModel parentModel,
                  AssertionData data)

ModelNode

private ModelNode(PolicySourceModel parentModel,
                  PolicyReferenceData data)

Method Detail

createRootPolicyNode

static ModelNode createRootPolicyNode(PolicySourceModel model)
                               throws java.lang.IllegalArgumentException

The factory method creates and initializes the POLICY model node and sets it's parent model reference to point to the model supplied as an input parameter. This method is intended to be used ONLY from PolicySourceModel during the initialization of its own internal structures.

Parameters:

model - policy source model to be used as a parent model of the newly created ModelNode. Must not be null

Returns:

POLICY model node with the parent model reference initialized to the model supplied as an input parameter

Throws:

java.lang.IllegalArgumentException - if the model input parameter is null

checkCreateChildOperationSupportForType

private void checkCreateChildOperationSupportForType(ModelNode.Type type)
                                              throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException

createChildPolicyNode

public ModelNode createChildPolicyNode()

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Returns:

A new Policy node.

createChildAllNode

public ModelNode createChildAllNode()

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Returns:

A new All node.

createChildExactlyOneNode

public ModelNode createChildExactlyOneNode()

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Returns:

A new ExactlyOne node.

createChildAssertionNode

public ModelNode createChildAssertionNode()

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Returns:

A new policy assertion node.

createChildAssertionNode

public ModelNode createChildAssertionNode(AssertionData nodeData)

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Parameters:

nodeData - The policy assertion data.

Returns:

A new policy assertion node.

createChildAssertionParameterNode

public ModelNode createChildAssertionParameterNode()

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Returns:

A new assertion parameter node.

createChildAssertionParameterNode

ModelNode createChildAssertionParameterNode(AssertionData nodeData)

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Parameters:

nodeData - The assertion parameter data.

Returns:

A new assertion parameter node.

createChildPolicyReferenceNode

ModelNode createChildPolicyReferenceNode(PolicyReferenceData referenceData)

Factory method that creates new policy source model node as specified by a factory method name and input parameters. Each node is created with respect to its enclosing policy source model.

Parameters:

referenceData - The PolicyReference data.

Returns:

A new PolicyReference node.

getChildren

java.util.Collection<ModelNode> getChildren()

setParentModel

void setParentModel(PolicySourceModel model)
             throws java.lang.IllegalAccessException

Sets the parent model reference on the node and its children. The method may be invoked only on the root node of the policy source model (or - in general - on a model node that dose not reference a parent node). Otherwise an exception is thrown.

Parameters:

model - new parent policy source model to be set.

Throws:

java.lang.IllegalAccessException - in case this node references a parent node (i.e. is not a root node of the model).

updateParentModelReference

private void updateParentModelReference(PolicySourceModel model)

The method updates the parentModel reference on current model node instance and all of it's children

Parameters:

model - new policy source model reference.

getParentModel

public PolicySourceModel getParentModel()

Returns the parent policy source model that contains this model node.

Returns:

the parent policy source model

getType

public ModelNode.Type getType()

Returns the type of this policy source model node.

Returns:

actual type of this policy source model node

getParentNode

public ModelNode getParentNode()

Returns the parent referenced by this policy source model node.

Returns:

current parent of this policy source model node or null if the node does not have a parent currently.

getNodeData

public AssertionData getNodeData()

Returns the data for this policy source model node (if any). The model node data are expected to be not null only in case the type of this node is ASSERTION or ASSERTION_PARAMETER_NODE.

Returns:

the data of this policy source model node or null if the node does not have any data associated to it attached.

getPolicyReferenceData

PolicyReferenceData getPolicyReferenceData()

Returns the policy reference data for this policy source model node. The policy reference data are expected to be not null only in case the type of this node is POLICY_REFERENCE.

Returns:

the policy reference data for this policy source model node or null if the node does not have any policy reference data attached.

setOrReplaceNodeData

public AssertionData setOrReplaceNodeData(AssertionData newData)

The method may be used to set or replace assertion data set for this node. If there are assertion data set already, those are replaced by a new reference and eventualy returned from the method.

This method is supported only in case this model node instance's type is ASSERTION or ASSERTION_PARAMETER_NODE. If used from other node types, an exception is thrown.

Parameters:

newData - new assertion data to be set.

Returns:

old and replaced assertion data if any or null otherwise.

Throws:

java.lang.UnsupportedOperationException - in case this method is called on nodes of type other than ASSERTION or ASSERTION_PARAMETER_NODE

isDomainSpecific

boolean isDomainSpecific()

The method specifies whether the model node instance represents assertion related node, it means whether its type is 'ASSERTION' or 'ASSERTION_PARAMETER_NODE'. This is, for example, the way to determine whether the node supports setting a AssertionData object via setOrReplaceNodeData(AssertionData) method or not.

Returns:

true or false according to whether the node instance represents assertion related node or not.

addChild

private boolean addChild(ModelNode child)

Appends the specified child node to the end of the children list of this node and sets it's parent to reference this node.

Parameters:

child - node to be appended to the children list of this node.

Returns:

true (as per the general contract of the Collection.add method).

Throws:

java.lang.NullPointerException - if the specified node is null.

java.lang.IllegalArgumentException - if child has a parent node set already to point to some node

setReferencedModel

void setReferencedModel(PolicySourceModel model)

getReferencedModel

PolicySourceModel getReferencedModel()

childrenSize

public int childrenSize()

Returns the number of child policy source model nodes. If this model node contains more than Integer.MAX_VALUE children, returns Integer.MAX_VALUE.

Returns:

the number of children of this node.

hasChildren

public boolean hasChildren()

Returns true if the node has at least one child node.

Returns:

true if the node has at least one child node, false otherwise.

iterator

public java.util.Iterator<ModelNode> iterator()

Iterates through all child nodes.

Specified by:

iterator in interface java.lang.Iterable<ModelNode>

Returns:

An iterator for the child nodes

equals

public boolean equals(java.lang.Object obj)

An Object.equals(Object obj) method override. Method ignores the parent source model. It means that two model nodes may be the same even if they belong to different models.

If parent model comparison is desired, it must be accomplished separately. To perform that, the reference equality test is sufficient (nodeA.getParentModel() == nodeB.getParentModel()), since all model nodes are created for specific model instances.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

An Object.hashCode() method override.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

toString

public java.lang.StringBuffer toString(int indentLevel,
                                       java.lang.StringBuffer buffer)

A helper method that appends indented string representation of this instance to the input string buffer.

Parameters:

indentLevel - indentation level to be used.

buffer - buffer to be used for appending string representation of this instance

Returns:

modified buffer containing new string representation of the instance

clone

protected ModelNode clone()
                   throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getReferenceData

PolicyReferenceData getReferenceData()