Package org.jivesoftware.openfire.group

Interface GroupAwareList<T>

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>

All Known Implementing Classes:

ConcurrentGroupList

public interface GroupAwareList<T>
extends List<T>

This list specifies additional methods that understand groups among the items in the list.

Author:

Tom Evans

Method Summary

Modifier and Type	Method	Description
Set<Group>	getGroups()	Returns the groups that are implied (resolvable) from the items in the list.
boolean	includes(Object o)	Returns true if the list contains the given JID.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Details

includes

boolean includes(Object o)

Returns true if the list contains the given JID. If the JID is not found explicitly, search the list for groups and look for the JID in each of the corresponding groups.

Parameters:

o - The target, presumably a JID

Returns:

True if the target is in the list, or in any groups in the list

getGroups

Set<Group> getGroups()

Returns the groups that are implied (resolvable) from the items in the list.

Returns:

A Set containing the groups in the list