net.luckperms.api.model

Interface PermissionHolder.Identifier

Enclosing interface:

PermissionHolder

public static interface PermissionHolder.Identifier

Represents a way to identify distinct PermissionHolders.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_TYPE The type of Group permission holders.
static String	USER_TYPE The type of User permission holders.

Method Summary

Modifier and Type	Method and Description
@NonNull String	getName() Gets the PermissionHolders generic name.
@NonNull String	getType() Gets the type of the PermissionHolder.

Field Detail

USER_TYPE

static final String USER_TYPE

The type of User permission holders.

See Also:

Constant Field Values

GROUP_TYPE

static final String GROUP_TYPE

The type of Group permission holders.

See Also:

Constant Field Values

Method Detail

getName

@NonNull String getName()

Gets the PermissionHolders generic name.

The result of this method is guaranteed to be a unique identifier for distinct instances of the same type of object.

For Users, this method returns a string representation of the users unique id.

For Groups, this method returns the group name.

The User.getUniqueId(), User.getUsername() and Group.getName() methods define a "tighter" specification for obtaining object identifiers.

Returns:

the identifier for this object. Either a uuid string or name.

getType

@NonNull String getType()

Gets the type of the PermissionHolder.

Returns:

the type