org.apache.commons.collections15.bag
Class AbstractSortedBagDecorator<E>

java.lang.Object
  extended by org.apache.commons.collections15.collection.AbstractCollectionDecorator<E>
      extended by org.apache.commons.collections15.bag.AbstractBagDecorator<E>
          extended by org.apache.commons.collections15.bag.AbstractSortedBagDecorator<E>
All Implemented Interfaces:
Iterable<E>, Collection<E>, Bag<E>, SortedBag<E>
Direct Known Subclasses:
UnmodifiableSortedBag

public abstract class AbstractSortedBagDecorator<E>
extends AbstractBagDecorator<E>
implements SortedBag<E>

Decorates another SortedBag to provide additional behaviour.

Methods are forwarded directly to the decorated bag.

Since:
Commons Collections 3.0
Version:
$Revision: 1.1 $ $Date: 2005/10/11 17:05:19 $
Author:
Matt Hall, John Watkinson, Stephen Colebourne

Field Summary
 
Fields inherited from class org.apache.commons.collections15.collection.AbstractCollectionDecorator
collection
 
Constructor Summary
protected AbstractSortedBagDecorator()
          Constructor only used in deserialization, do not use otherwise.
protected AbstractSortedBagDecorator(SortedBag<E> bag)
          Constructor that wraps (not copies).
 
Method Summary
 Comparator<? super E> comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 E first()
          Returns the first (lowest) member.
protected  SortedBag<E> getSortedBag()
          Gets the bag being decorated.
 E last()
          Returns the last (highest) member.
 
Methods inherited from class org.apache.commons.collections15.bag.AbstractBagDecorator
add, getBag, getCount, remove, uniqueSet
 
Methods inherited from class org.apache.commons.collections15.collection.AbstractCollectionDecorator
add, addAll, clear, contains, containsAll, equals, getCollection, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections15.Bag
add, add, containsAll, getCount, iterator, remove, remove, removeAll, retainAll, size, uniqueSet
 
Methods inherited from interface java.util.Collection
addAll, clear, contains, equals, hashCode, isEmpty, toArray, toArray
 

Constructor Detail

AbstractSortedBagDecorator

protected AbstractSortedBagDecorator()
Constructor only used in deserialization, do not use otherwise.

Since:
Commons Collections 3.1

AbstractSortedBagDecorator

protected AbstractSortedBagDecorator(SortedBag<E> bag)
Constructor that wraps (not copies).

Parameters:
bag - the bag to decorate, must not be null
Throws:
IllegalArgumentException - if list is null
Method Detail

getSortedBag

protected SortedBag<E> getSortedBag()
Gets the bag being decorated.

Returns:
the decorated bag

first

public E first()
Description copied from interface: SortedBag
Returns the first (lowest) member.

Specified by:
first in interface SortedBag<E>
Returns:
the first element in the sorted bag

last

public E last()
Description copied from interface: SortedBag
Returns the last (highest) member.

Specified by:
last in interface SortedBag<E>
Returns:
the last element in the sorted bag

comparator

public Comparator<? super E> comparator()
Description copied from interface: SortedBag
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Specified by:
comparator in interface SortedBag<E>
Returns:
the comparator in use, or null if natural ordering


Copyright © 2001-2010 Apache Software Foundation. All Rights Reserved.