Package org.apache.commons.collections.bag

Class TypedBag

java.lang.Object

org.apache.commons.collections.bag.TypedBag

@Deprecated(since="2021-04-30")
public class TypedBag
extends java.lang.Object

Deprecated.

Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.

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.

Since:

Commons Collections 3.0

Method Summary

Modifier and Type	Method	Description
static Bag	decorate(Bag bag, java.lang.Class type)	Deprecated. Factory method to create a typed bag.

Methods inherited from class java.lang.Object

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

Method Detail

decorate

public static Bag decorate(Bag bag,
                           java.lang.Class type)

Deprecated.

Factory method to create a typed bag.

If there are any elements already in the bag being decorated, they are validated.

Parameters:

bag - the bag to decorate, must not be null

type - the type to allow into the bag, must not be null

Returns:

a new typed Bag

Throws:

java.lang.IllegalArgumentException - if bag or type is null

java.lang.IllegalArgumentException - if the bag contains invalid elements