com.sun.xml.ws.policy

Class AssertionSet

java.lang.Object

com.sun.xml.ws.policy.AssertionSet

All Implemented Interfaces:

java.lang.Comparable<AssertionSet>, java.lang.Iterable<PolicyAssertion>

public final class AssertionSet
extends java.lang.Object
implements java.lang.Iterable<PolicyAssertion>, java.lang.Comparable<AssertionSet>

The AssertionSet is a set of assertions. It represents a single policy alternative.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Comparator<PolicyAssertion>	ASSERTION_COMPARATOR The comparator comapres policy assertions according to their publicly accessible attributes, in the following order of attributes: 1.
private java.util.List<PolicyAssertion>	assertions
private static AssertionSet	EMPTY_ASSERTION_SET
private java.util.Collection<javax.xml.namespace.QName>	immutableVocabulary
private java.util.Set<javax.xml.namespace.QName>	vocabulary

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AssertionSet(java.util.Collection<AssertionSet> alternatives)
private	AssertionSet(java.util.List<PolicyAssertion> list)

Method Summary

Modifier and Type	Method and Description
private boolean	add(PolicyAssertion assertion)
private boolean	addAll(java.util.Collection<? extends PolicyAssertion> assertions)
private boolean	areAssertionsCompatible(AssertionSet alternative, PolicyIntersector.CompatibilityMode mode)
int	compareTo(AssertionSet that) An Comparable<T>.compareTo(T o) interface method implementation.
boolean	contains(javax.xml.namespace.QName assertionName) Returns true if the assertion set contains the assertion name specified in its vocabulary
static AssertionSet	createAssertionSet(java.util.Collection<? extends PolicyAssertion> assertions) Creates and returns new assertion set holding a set of provided policy assertions.
static AssertionSet	createMergedAssertionSet(java.util.Collection<AssertionSet> alternatives) Creates and returns new assertion set holding content of all provided policy assertion sets.
static AssertionSet	emptyAssertionSet()
boolean	equals(java.lang.Object obj) An Object.equals(Object obj) method override.
java.util.Collection<PolicyAssertion>	get(javax.xml.namespace.QName name) Searches for assertions with given name.
(package private) java.util.Collection<PolicyAssertion>	getAssertions() Return all assertions contained in this assertion set.
(package private) java.util.Collection<javax.xml.namespace.QName>	getVocabulary() Retrieves the vocabulary of this policy expression.
int	hashCode() An Object.hashCode() method override.
(package private) boolean	isCompatibleWith(AssertionSet alternative, PolicyIntersector.CompatibilityMode mode) Checks whether this policy alternative is compatible with the provided policy alternative.
boolean	isEmpty() Returns true if this assertion set contains no assertions.
java.util.Iterator<PolicyAssertion>	iterator() Returns an iterator over a set of child policy assertion objects.
java.lang.String	toString() An Object.toString() method override.
(package private) 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY_ASSERTION_SET

private static final AssertionSet EMPTY_ASSERTION_SET

ASSERTION_COMPARATOR

private static final java.util.Comparator<PolicyAssertion> ASSERTION_COMPARATOR

The comparator comapres policy assertions according to their publicly accessible attributes, in the following order of attributes: 1. namespace (not null String) 2. local name (not null String) 3. value (String): null < "" < "not empty" 4. has nested assertions (boolean): false < true 5. has nested policy (boolean): false < true 6. hashCode comparison

assertions

private final java.util.List<PolicyAssertion> assertions

vocabulary

private final java.util.Set<javax.xml.namespace.QName> vocabulary

immutableVocabulary

private final java.util.Collection<javax.xml.namespace.QName> immutableVocabulary

Constructor Detail

AssertionSet

private AssertionSet(java.util.List<PolicyAssertion> list)

AssertionSet

private AssertionSet(java.util.Collection<AssertionSet> alternatives)

Method Detail

add

private boolean add(PolicyAssertion assertion)

addAll

private boolean addAll(java.util.Collection<? extends PolicyAssertion> assertions)

getAssertions

java.util.Collection<PolicyAssertion> getAssertions()

Return all assertions contained in this assertion set.

Returns:

All assertions contained in this assertion set

getVocabulary

java.util.Collection<javax.xml.namespace.QName> getVocabulary()

Retrieves the vocabulary of this policy expression. The vocabulary is represented by an immutable collection of unique QName objects. Each of those objects represents single assertion type contained in the assertion set.

Returns:

immutable collection of assertion types contained in the assertion set (a policy vocabulary).

isCompatibleWith

boolean isCompatibleWith(AssertionSet alternative,
                         PolicyIntersector.CompatibilityMode mode)

Checks whether this policy alternative is compatible with the provided policy alternative.

Parameters:

alternative - policy alternative used for compatibility test

mode - compatibility mode to be used

Returns:

true if the two policy alternatives are compatible, false otherwise

areAssertionsCompatible

private boolean areAssertionsCompatible(AssertionSet alternative,
                                        PolicyIntersector.CompatibilityMode mode)

createMergedAssertionSet

public static AssertionSet createMergedAssertionSet(java.util.Collection<AssertionSet> alternatives)

Creates and returns new assertion set holding content of all provided policy assertion sets.

This method should not be used to perform a merge of general Policy instances. A client should be aware of the method's result meaning and the difference between merge of Policy instances and merge of AssertionSet instances.

Parameters:

alternatives - collection of provided policy assertion sets which content is to be stored in the assertion set. May be null - empty assertion set is returned in such case.

Returns:

new instance of assertion set holding the content of all provided policy assertion sets.

createAssertionSet

public static AssertionSet createAssertionSet(java.util.Collection<? extends PolicyAssertion> assertions)

Creates and returns new assertion set holding a set of provided policy assertions.

Parameters:

assertions - collection of provided policy assertions to be stored in the assertion set. May be null.

Returns:

new instance of assertion set holding the provided policy assertions

emptyAssertionSet

public static AssertionSet emptyAssertionSet()

iterator

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

Returns an iterator over a set of child policy assertion objects.

Specified by:

iterator in interface java.lang.Iterable<PolicyAssertion>

Returns:

policy assertion Iterator.

get

public java.util.Collection<PolicyAssertion> get(javax.xml.namespace.QName name)

Searches for assertions with given name. Only assertions that are contained as immediate children of the assertion set are searched, i.e. nested policies are not searched.

Parameters:

name - The fully qualified name of searched assertion

Returns:

List of all assertions matching the requested name. If no assertions are found, the returned list is empty (i.e. null value is never returned).

isEmpty

public boolean isEmpty()

Returns true if this assertion set contains no assertions.

Returns:

true if this assertion set contains no assertions.

contains

public boolean contains(javax.xml.namespace.QName assertionName)

Returns true if the assertion set contains the assertion name specified in its vocabulary

Parameters:

assertionName - the fully qualified name of the assertion

Returns:

true, if an assertion with the given name could be found in the assertion set vocabulary false otherwise.

compareTo

public int compareTo(AssertionSet that)

An Comparable<T>.compareTo(T o) interface method implementation.

Specified by:

compareTo in interface java.lang.Comparable<AssertionSet>

Parameters:

that - other alternative to compare with

equals

public boolean equals(java.lang.Object obj)

An Object.equals(Object obj) method override.

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()

An Object.toString() method override.

Overrides:

toString in class java.lang.Object

toString

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