Home >> All >> org >> apache >> commons >> collections >> [ bag Javadoc ]

• org.apache.commons.collections.bag: Javadoc index of package org.apache.commons.collections.bag.


Package Samples:

• org.apache.commons.collections.bag

Classes:

• TreeBag: Implements SortedBag , using a TreeMap to provide the data storage. This is the standard implementation of a sorted bag. Order will be maintained among the bag members and can be viewed through the iterator. A Bag stores each object in the collection together with a count of occurrences. Extra methods on the interface allow multiple copies of an object to be added or removed at once. It is important to read the interface javadoc carefully as several methods violate the Collection interface specification.
• PredicatedSortedBag: Decorates another SortedBag to validate that additions match a specified predicate. This bag exists to provide validation for the decorated bag. It is normally created to decorate an empty bag. If an object cannot be added to the bag, an IllegalArgumentException is thrown. One usage would be to ensure that no null entries are added to the bag. SortedBag bag = PredicatedSortedBag.decorate(new TreeBag(), NotNullPredicate.INSTANCE); This class is Serializable from Commons Collections 3.1.
• PredicatedBag: Decorates another Bag to validate that additions match a specified predicate. This bag exists to provide validation for the decorated bag. It is normally created to decorate an empty bag. If an object cannot be added to the bag, an IllegalArgumentException is thrown. One usage would be to ensure that no null entries are added to the bag. Bag bag = PredicatedBag.decorate(new HashBag(), NotNullPredicate.INSTANCE); This class is Serializable from Commons Collections 3.1.
• HashBag: Implements Bag , using a HashMap to provide the data storage. This is the standard implementation of a bag. A Bag stores each object in the collection together with a count of occurrences. Extra methods on the interface allow multiple copies of an object to be added or removed at once. It is important to read the interface javadoc carefully as several methods violate the Collection interface specification.
• AbstractTestBag: Abstract test class for Bag methods and contracts. To use, simply extend this class, and implement the makeBag() 55 method. If your bag fails one of these tests by design, you may still use this base set of cases. Simply override the test case (method) your bag fails.
• AbstractMapBag: Abstract implementation of the org.apache.commons.collections.Bag interface to simplify the creation of subclass implementations. Subclasses specify a Map implementation to use as the internal storage. The map will be used to map bag elements to a number; the number represents the number of occurrences of that element in the bag.
• TransformedSortedBag: Decorates another SortedBag to transform objects that are added. The add methods are affected by this class. Thus objects must be removed or searched for using their transformed form. For example, if the transformation converts Strings to Integers, you must use the Integer form to remove objects. This class is Serializable from Commons Collections 3.1.
• TransformedBag: Decorates another Bag to transform objects that are added. The add methods are affected by this class. Thus objects must be removed or searched for using their transformed form. For example, if the transformation converts Strings to Integers, you must use the Integer form to remove objects. This class is Serializable from Commons Collections 3.1.
• TypedSortedBag: Decorates another SortedBag to validate that elements added are of a specific type. The validation of additions is performed via an instanceof test against a specified Class . If an object cannot be added to the collection, an IllegalArgumentException is thrown.
• SynchronizedSortedBag: Decorates another SortedBag to synchronize its behaviour for a multi-threaded environment. Methods are synchronized, then forwarded to the decorated bag. Iterators must be separately synchronized around the loop. This class is Serializable from Commons Collections 3.1.
• TypedBag: Decorates another Bag to validate that elements added are of a specific type. The validation of additions is performed via an instanceof test against a specified Class . If an object cannot be added to the collection, an IllegalArgumentException is thrown.
• SynchronizedBag: Decorates another Bag to synchronize its behaviour for a multi-threaded environment. Methods are synchronized, then forwarded to the decorated bag. Iterators must be separately synchronized around the loop. This class is Serializable from Commons Collections 3.1.
• TestTransformedSortedBag: Extension of TestSortedBag for exercising the TransformedSortedBag implementation.
• TestPredicatedSortedBag: Extension of TestBag for exercising the PredicatedSortedBag implementation.
• TestTypedSortedBag: Extension of TestBag for exercising the TypedSortedBag implementation.
• TestTransformedBag: Extension of TestBag for exercising the TransformedBag implementation.
• TestPredicatedBag: Extension of TestBag for exercising the PredicatedBag implementation.
• TestTypedBag: Extension of TestBag for exercising the TypedBag implementation.
• TestTreeBag: Extension of TestBag for exercising the TreeBag implementation.
• TestHashBag: Extension of TestBag for exercising the HashBag implementation.
• AbstractTestSortedBag: Abstract test class for SortedBag methods and contracts.
• UnmodifiableSortedBag: Decorates another SortedBag to ensure it can't be altered. This class is Serializable from Commons Collections 3.1.
• AbstractSortedBagDecorator: Decorates another SortedBag to provide additional behaviour. Methods are forwarded directly to the decorated bag.
• UnmodifiableBag: Decorates another Bag to ensure it can't be altered. This class is Serializable from Commons Collections 3.1.
• AbstractBagDecorator: Decorates another Bag to provide additional behaviour. Methods are forwarded directly to the decorated bag.

Home | Contact Us | Privacy Policy | Terms of Service