javax.accessibility
Class AccessibleRelationSet

java.lang.Object
  extended by javax.accessibility.AccessibleRelationSet

public class AccessibleRelationSet
extends Object

Describes all relations of an accessible object. For example, an object by labeled by one object and control another.

Since:
1.2
See Also:
AccessibleRelation

Field Summary
protected  Vector<AccessibleRelation> relations
          The list of relations, should be instances of AccessibleRelation.
 
Constructor Summary
AccessibleRelationSet()
          Create an empty relation set.
AccessibleRelationSet(AccessibleRelation[] relations)
          Create a relation set initialized with the given relations, duplicates are ignored.
 
Method Summary
 boolean add(AccessibleRelation relation)
          Add a new relation to the current set.
 void addAll(AccessibleRelation[] array)
          Add all of the relations to the current set.
 void clear()
          Clear all relations in the set.
 boolean contains(String key)
          Check if the relation key is in the set.
 AccessibleRelation get(String key)
          Get the relation that matches the key.
 boolean remove(AccessibleRelation relation)
          Remove a relation from the set.
 int size()
          Return the number of relations in the set.
 AccessibleRelation[] toArray()
          Return the relation set as an array.
 String toString()
          Return a localized, comma-separated string representing all relations in the set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

relations

protected Vector<AccessibleRelation> relations
The list of relations, should be instances of AccessibleRelation. Don't set this to null.

See Also:
add(AccessibleRelation), addAll(AccessibleRelation[]), remove(AccessibleRelation), contains(String), get(String), size(), toArray(), clear()
Constructor Detail

AccessibleRelationSet

public AccessibleRelationSet()
Create an empty relation set.


AccessibleRelationSet

public AccessibleRelationSet(AccessibleRelation[] relations)
Create a relation set initialized with the given relations, duplicates are ignored.

Parameters:
relations - the relations to insert
Throws:
NullPointerException - if relations is null
Method Detail

add

public boolean add(AccessibleRelation relation)
Add a new relation to the current set. If the relation is already in the set, the targets are merged with the existing relation, possibly resulting in an object being in the target list more than once. Do not add a relation with a null key, as it will cause problems later.

Parameters:
relation - the relation to add
Returns:
true if the set was modified, which is always the case
Throws:
NullPointerException - if relation is null

addAll

public void addAll(AccessibleRelation[] array)
Add all of the relations to the current set. Duplicates are ignored.

Parameters:
array - the array of relations to add
Throws:
NullPointerException - if array is null or has null entries

remove

public boolean remove(AccessibleRelation relation)
Remove a relation from the set. If a relation was removed, return true. Note that this uses AccessibleRelation.equals, which defaults to ==, so a relation with the same key may still exist in the set afterwords.

Parameters:
relation - the state to remove
Returns:
true if the set changed

clear

public void clear()
Clear all relations in the set.


size

public int size()
Return the number of relations in the set.

Returns:
the set size

contains

public boolean contains(String key)
Check if the relation key is in the set.

Parameters:
key - the relation to locate
Returns:
true if it is in the set

get

public AccessibleRelation get(String key)
Get the relation that matches the key.

Parameters:
key - the relation to locate
Returns:
the relation in the set, or null

toArray

public AccessibleRelation[] toArray()
Return the relation set as an array.

Returns:
an array of the current relations

toString

public String toString()
Return a localized, comma-separated string representing all relations in the set. This is in arbitrary order.

Overrides:
toString in class Object
Returns:
the string representation
See Also:
AccessibleBundle.toDisplayString(String, Locale)