net.shibboleth.metadata.util

Class ItemCollectionWithMetadata<T>

java.lang.Object

net.shibboleth.metadata.util.ItemCollectionWithMetadata<T>

Type Parameters:

T - type of items stored in this collection

All Implemented Interfaces:

Iterable<Item<T>>, Collection<Item<T>>

public class ItemCollectionWithMetadata<T>
extends Object
implements Collection<Item<T>>

A wrapper around a delegate collection that allows the collection to carry item metadata.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<Item<T>>	delegate The delegate collection.
private net.shibboleth.utilities.java.support.collection.ClassToInstanceMultiMap<ItemMetadata>	metadata Additional processing information associated with this collection of Items.

Constructor Summary

Constructors

Constructor and Description
ItemCollectionWithMetadata() Constructor.
ItemCollectionWithMetadata(Collection<Item<T>> wrappedCollection) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Item<T> e)
boolean	addAll(Collection<? extends Item<T>> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
net.shibboleth.utilities.java.support.collection.ClassToInstanceMultiMap<ItemMetadata>	getCollectionMetadata() Gets the ItemMetadata for this collection.
boolean	isEmpty()
Iterator<Item<T>>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<TT> TT[]	toArray(TT[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Field Detail

delegate

private final Collection<Item<T>> delegate

The delegate collection.

metadata

private final net.shibboleth.utilities.java.support.collection.ClassToInstanceMultiMap<ItemMetadata> metadata

Additional processing information associated with this collection of Items.

Constructor Detail

ItemCollectionWithMetadata

public ItemCollectionWithMetadata()

Constructor.

ItemCollectionWithMetadata

public ItemCollectionWithMetadata(@Nonnull@NonnullElements
                          Collection<Item<T>> wrappedCollection)

Constructor.

Parameters:

wrappedCollection - the underlying collection that holds the items

Method Detail

getCollectionMetadata

@Nonnull
@NonnullElements
public net.shibboleth.utilities.java.support.collection.ClassToInstanceMultiMap<ItemMetadata> getCollectionMetadata()

Gets the ItemMetadata for this collection.

Returns:

the ItemMetadata for this collection, never null

size

public int size()

Specified by:

size in interface Collection<Item<T>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Item<T>>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Item<T>>

iterator

@Nonnull
@NonnullElements
public Iterator<Item<T>> iterator()

Specified by:

iterator in interface Iterable<Item<T>>

Specified by:

iterator in interface Collection<Item<T>>

toArray

@Nonnull
@NonnullElements
public Object[] toArray()

Specified by:

toArray in interface Collection<Item<T>>

toArray

@Nonnull
@NonnullElements
public <TT> TT[] toArray(@Nonnull
                                        TT[] a)

Specified by:

toArray in interface Collection<Item<T>>

add

public boolean add(@Nullable
          Item<T> e)

Specified by:

add in interface Collection<Item<T>>

remove

public boolean remove(@Nullable
             Object o)

Specified by:

remove in interface Collection<Item<T>>

containsAll

public boolean containsAll(@Nonnull
                  Collection<?> c)

Specified by:

containsAll in interface Collection<Item<T>>

addAll

public boolean addAll(@Nullable
             Collection<? extends Item<T>> c)

Specified by:

addAll in interface Collection<Item<T>>

removeAll

public boolean removeAll(@Nullable
                Collection<?> c)

Specified by:

removeAll in interface Collection<Item<T>>

retainAll

public boolean retainAll(@Nonnull
                Collection<?> c)

Specified by:

retainAll in interface Collection<Item<T>>

clear

public void clear()

Specified by:

clear in interface Collection<Item<T>>