UserSet (Fulcrum Security Master Build 2.1.0 API)

java.lang.Object
- org.apache.fulcrum.security.util.SecuritySet<User>
- - org.apache.fulcrum.security.util.UserSet<T>

All Implemented Interfaces:

Serializable, Iterable<User>, Collection<User>, Set<User>
```
public class UserSet<T extends User>
extends SecuritySet<User>
```
This class represents a set of Users. It is based on UserSet. Hibernate doesn't return the right kind of set, so this is used to force the type of set.

Version:

$Id$

Author:

Eric Pugh

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.apache.fulcrum.security.util.SecuritySet
  idMap, nameMap

Constructor Summary

Constructors
Constructor Description

UserSet()
Constructs an empty UserSet

UserSet(Collection<? extends User> users)
Constructs a new UserSet with specified contents.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`User`	`getUserById(Object userId)`	Deprecated. use getById()
`User`	`getUserByName(String userName)`	Deprecated. use getByName()
`String`	`toString()`	Print out a UserSet as a String

Methods inherited from class org.apache.fulcrum.security.util.SecuritySet
add, add, addAll, clear, contains, containsAll, containsId, containsName, getById, getByName, getIds, getNames, getSet, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
equals, hashCode, spliterator

- Constructor Detail
  - UserSet
```
public UserSet()
```
    Constructs an empty UserSet
  - UserSet
```
public UserSet(Collection<? extends User> users)
```
    Constructs a new UserSet with specified contents. If the given collection contains multiple objects that are identical WRT equals() method, some objects will be overwritten.
    
    Parameters:
    
    users - A collection of users to be contained in the set.
- Method Detail
  - getUserByName
```
@Deprecated
public User getUserByName(String userName)
```
    Deprecated.
    use getByName()
    
    Returns a User with the given name, if it is contained in this UserSet.
    
    Parameters:
    
    userName - Name of User.
    
    Returns:
    
    User if argument matched a User in this UserSet; null if no match.
  - getUserById
```
@Deprecated
public User getUserById(Object userId)
```
    Deprecated.
    use getById()
    
    Returns a User with the given id, if it is contained in this UserSet.
    
    Parameters:
    
    userId - id of the User.
    
    Returns:
    
    User if argument matched a User in this UserSet; null if no match.
  - toString
```
public String toString()
```
    Print out a UserSet as a String
    
    Overrides:
    
    toString in class SecuritySet<User>
    
    Returns:
    
    The User Set as String