com.silverpeas.subscribe.util
Class SubscriptionSubscriberList

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.ArrayList<SubscriptionSubscriber>
              com.silverpeas.subscribe.util.SubscriptionSubscriberList

All Implemented Interfaces:

Serializable, Cloneable, Iterable<SubscriptionSubscriber>, Collection<SubscriptionSubscriber>, List<SubscriptionSubscriber>, RandomAccess

public class SubscriptionSubscriberList
extends ArrayList<SubscriptionSubscriber>

Author:

Yohann Chastagnier

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

SubscriptionSubscriberList()

SubscriptionSubscriberList(Collection<? extends SubscriptionSubscriber> c)

Method Summary

SubscriptionSubscriberList	filterOnDomainVisibilityFrom(UserDetail user) Removes from this list the subscribers that have not the same domain visibility as the one of the given user.
List<String>	getAllIds() Retrieves from the list content all identifiers of SubscriptionSubscriber.
List<String>	getAllUserIds() Retrieves from the list content all unique identifiers of user identifiers (so the users of groups are taken into account).
SubscriptionSubscriberMapBySubscriberType	indexBySubscriberType() Obtains subscription subscribers indexed by their type.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList

Constructor Detail

SubscriptionSubscriberList

public SubscriptionSubscriberList()

SubscriptionSubscriberList

public SubscriptionSubscriberList(Collection<? extends SubscriptionSubscriber> c)

Method Detail

getAllIds

public List<String> getAllIds()

Retrieves from the list content all identifiers of SubscriptionSubscriber. No filter is applied according to the SubscriberType.

Returns:

a list of identifiers of any kind of SubscriberType.

getAllUserIds

public List<String> getAllUserIds()

Retrieves from the list content all unique identifiers of user identifiers (so the users of groups are taken into account).

Returns:

the complete list of user identifiers (those of groups too).

indexBySubscriberType

public SubscriptionSubscriberMapBySubscriberType indexBySubscriberType()

Obtains subscription subscribers indexed by their type.

Returns:

an instance of SubscriptionSubscriberMapBySubscriberType.

filterOnDomainVisibilityFrom

public SubscriptionSubscriberList filterOnDomainVisibilityFrom(UserDetail user)

Removes from this list the subscribers that have not the same domain visibility as the one of the given user.

Parameters:

user - the user that represents the visibility to verify.

Returns:

itself.