com.helger.photon.basic.security.user

Interface IUserContainer

All Known Subinterfaces:

IUserGroup

All Known Implementing Classes:

UserGroup

public interface IUserContainer

Base read-only interface for objects containing users.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsUserID(String sUserID) Check if the passed user is contained in this container.
Set<String>	getAllContainedUserIDs()
int	getContainedUserCount()
boolean	hasContainedUsers()

Method Detail

hasContainedUsers

boolean hasContainedUsers()

Returns:

true if at least one user is contained, false otherwise.

getContainedUserCount

@Nonnegative
int getContainedUserCount()

Returns:

The number of contained users. Always ≥ 0.

getAllContainedUserIDs

@Nonnull
@ReturnsMutableCopy
Set<String> getAllContainedUserIDs()

Returns:

A non-nullbut maybe empty set of all assigned user IDs.

containsUserID

boolean containsUserID(String sUserID)

Check if the passed user is contained in this container.

Parameters:

sUserID - The user ID to check. May be null.

Returns:

true if the user is contained in this container, false otherwise.