me.lucko.luckperms.api

Interface Group

All Superinterfaces:

PermissionHolder

public interface Group
extends PermissionHolder

An inheritable holder of permission data.

Method Summary

Modifier and Type	Method and Description
@NonNull GroupData	getCachedData() Gets the groups's GroupData cache.
@Nullable String	getDisplayName() Gets the groups "display name", if it has one that differs from it's actual name.
@Nullable String	getDisplayName(@NonNull ContextSet contextSet) Gets the groups "display name", if it has one that differs from it's actual name.
@NonNull String	getName() Get the name of the group
@NonNull OptionalInt	getWeight() Gets the weight of this group, if present.

Methods inherited from interface me.lucko.luckperms.api.PermissionHolder

auditTemporaryPermissions, clearMatching, clearMatchingTransient, clearMeta, clearMeta, clearNodes, clearNodes, clearParents, clearParents, clearTransientNodes, exportNodes, getAllNodes, getAllNodes, getAllNodesFiltered, getEnduringPermissions, getFriendlyName, getNodes, getObjectName, getOwnNodes, getPermanentPermissionNodes, getPermissions, getTemporaryPermissionNodes, getTransientNodes, getTransientPermissions, hasPermission, hasPermission, hasTransientPermission, hasTransientPermission, inheritsGroup, inheritsGroup, inheritsPermission, inheritsPermission, refreshCachedData, resolveInheritances, resolveInheritances, setPermission, setPermission, setPermissionUnchecked, setTransientPermission, setTransientPermission, setTransientPermissionUnchecked, unsetPermission, unsetPermissionUnchecked, unsetTransientPermission, unsetTransientPermissionUnchecked

Method Detail

getName

@NonNull String getName()

Get the name of the group

Returns:

the name of the group

getDisplayName

@Nullable String getDisplayName()

Gets the groups "display name", if it has one that differs from it's actual name.

The lookup is made using the current servers active context.

Will return null if the groups display name is equal to it's actual name.

Returns:

the display name

Since:

4.3

getDisplayName

@Nullable String getDisplayName(@NonNull ContextSet contextSet)

Gets the groups "display name", if it has one that differs from it's actual name.

Will return null if the groups display name is equal to it's actual name.

Parameters:

contextSet - the contexts to lookup in

Returns:

the display name

Since:

4.3

getWeight

@NonNull OptionalInt getWeight()

Gets the weight of this group, if present.

Returns:

the group weight

Since:

2.17

getCachedData

@NonNull GroupData getCachedData()

Gets the groups's GroupData cache.

Specified by:

getCachedData in interface PermissionHolder

Returns:

the groups cached data.

Since:

4.0