org.apache.catalina.util

Class ResourceSet

public final class ResourceSet extends HashSet

Extended implementation of HashSet that includes a locked property. This class can be used to safely expose resource path sets to user classes without having to clone them in order to avoid modifications. When first created, a ResourceMap is not locked.

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Constructor Summary
ResourceSet()
Construct a new, empty set with the default initial capacity and load factor.
ResourceSet(int initialCapacity)
Construct a new, empty set with the specified initial capacity and default load factor.
ResourceSet(int initialCapacity, float loadFactor)
Construct a new, empty set with the specified initial capacity and load factor.
ResourceSet(Collection coll)
Construct a new set with the same contents as the existing collection.
Method Summary
booleanadd(Object o)
Add the specified element to this set if it is not already present.
voidclear()
Remove all of the elements from this set.
booleanisLocked()
Return the locked state of this parameter map.
booleanremove(Object o)
Remove the given element from this set if it is present.
voidsetLocked(boolean locked)
Set the locked state of this parameter map.

Constructor Detail

ResourceSet

public ResourceSet()
Construct a new, empty set with the default initial capacity and load factor.

ResourceSet

public ResourceSet(int initialCapacity)
Construct a new, empty set with the specified initial capacity and default load factor.

Parameters: initialCapacity The initial capacity of this set

ResourceSet

public ResourceSet(int initialCapacity, float loadFactor)
Construct a new, empty set with the specified initial capacity and load factor.

Parameters: initialCapacity The initial capacity of this set loadFactor The load factor of this set

ResourceSet

public ResourceSet(Collection coll)
Construct a new set with the same contents as the existing collection.

Parameters: coll The collection whose contents we should copy

Method Detail

add

public boolean add(Object o)
Add the specified element to this set if it is not already present. Return true if the element was added.

Parameters: o The object to be added

Throws: IllegalStateException if this ResourceSet is locked

clear

public void clear()
Remove all of the elements from this set.

Throws: IllegalStateException if this ResourceSet is locked

isLocked

public boolean isLocked()
Return the locked state of this parameter map.

remove

public boolean remove(Object o)
Remove the given element from this set if it is present. Return true if the element was removed.

Parameters: o The object to be removed

Throws: IllegalStateException if this ResourceSet is locked

setLocked

public void setLocked(boolean locked)
Set the locked state of this parameter map.

Parameters: locked The new locked state

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.