Added in API level 1
Deprecated in API level 33

Group

interface Group : Principal
java.security.acl.Group

This interface is used to represent a group of principals. (A principal represents an entity such as an individual user or a company).

Note that Group extends Principal. Thus, either a Principal or a Group can be passed as an argument to methods containing a Principal parameter. For example, you can add either a Principal or a Group to a Group object by calling the object's addMember method, passing it the Principal or Group.

Summary

Public methods
abstract Boolean

Adds the specified member to the group.

abstract Boolean
isMember(member: Principal!)

Returns true if the passed principal is a member of the group.

abstract Enumeration<out Principal!>!

Returns an enumeration of the members in the group.

abstract Boolean

Removes the specified member from the group.

Inherited functions

Public methods

addMember

Added in API level 1
abstract fun addMember(user: Principal!): Boolean

Deprecated: Deprecated in Java.

Adds the specified member to the group.

Parameters
user Principal!: the principal to add to this group.
Return
Boolean true if the member was successfully added, false if the principal was already a member.

isMember

Added in API level 1
abstract fun isMember(member: Principal!): Boolean

Deprecated: Deprecated in Java.

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned.

Parameters
member Principal!: the principal whose membership is to be checked.
Return
Boolean true if the principal is a member of this group, false otherwise.

members

Added in API level 1
abstract fun members(): Enumeration<out Principal!>!

Deprecated: Deprecated in Java.

Returns an enumeration of the members in the group. The returned objects can be instances of either Principal or Group (which is a subclass of Principal).

Return
Enumeration<out Principal!>! an enumeration of the group members.

removeMember

Added in API level 1
abstract fun removeMember(user: Principal!): Boolean

Deprecated: Deprecated in Java.

Removes the specified member from the group.

Parameters
user Principal!: the principal to remove from this group.
Return
Boolean true if the principal was removed, or false if the principal was not a member.