Package xaero.pac.common.server.player.config.group.custom.api

Interface ICustomPlayerConfigGroupAPI

All Superinterfaces:

ICustomPlayerConfigGroupDataAPI

public interface ICustomPlayerConfigGroupAPI
extends ICustomPlayerConfigGroupDataAPI

API for a custom player config group

Method Summary

Modifier and Type	Method	Description
ICustomPlayerConfigGroupDataAPI	copyData()	Creates a copy of the stored data.
Optional<PlayerConfigGroupActionError>	excludeGroup(String groupId)	Attempts to exclude the group with a specified ID from this group.
Optional<PlayerConfigGroupActionError>	excludeMember(UUID id, String name)	Attempts to exclude the member entry with a specified UUID and/or name from this group.
Optional<PlayerConfigGroupActionError>	excludeMember(ICustomPlayerGroupMemberAPI member)	Attempts to exclude a specified member entry from this group.
Set<String>	getDirectGroupIds()	Gets a set containing all group IDs directly included in this group.
Set<ICustomPlayerGroupMemberAPI>	getDirectMembers()	Gets a set of member entries directly included in this group.
int	getSize()	Gets the size of this custom player group (included members and groups).
boolean	groupIdIsIncluded(String groupId)	Checks whether a specified group ID is included in this group.
Optional<PlayerConfigGroupActionError>	includeGroup(String groupId)	Attempts to include the group with a specified ID in this group.
Optional<PlayerConfigGroupActionError>	includeGroupLimited(String groupId)	Attempts to include the group with a specified ID in this group.
com.mojang.datafixers.util.Either<ICustomPlayerGroupMemberAPI,PlayerConfigGroupActionError>	includeMember(UUID id, String name)	Attempts to include a member in this group using specified UUID or player name.
com.mojang.datafixers.util.Either<ICustomPlayerGroupMemberAPI,PlayerConfigGroupActionError>	includeMemberLimited(UUID id, String name)	Attempts to include a member in this group using specified UUID or player name.
boolean	playerIdIsIncluded(UUID playerId)	Checks whether the player with a specified UUID is one of the member entries.
boolean	playerNameIsIncluded(String name)	Checks whether a specified player name is one of the member entries.

Method Details

copyData

@Nonnull
ICustomPlayerConfigGroupDataAPI copyData()

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Creates a copy of the stored data.

Specified by:

copyData in interface ICustomPlayerConfigGroupDataAPI

Returns:

the copy, not null

getSize

int getSize()

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Gets the size of this custom player group (included members and groups).

Specified by:

getSize in interface ICustomPlayerConfigGroupDataAPI

Returns:

the size of the data

getDirectMembers

@Nonnull
Set<ICustomPlayerGroupMemberAPI> getDirectMembers()

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Gets a set of member entries directly included in this group.

Specified by:

getDirectMembers in interface ICustomPlayerConfigGroupDataAPI

Returns:

the set of direct member entries, not null

getDirectGroupIds

@Nonnull
Set<String> getDirectGroupIds()

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Gets a set containing all group IDs directly included in this group.

Specified by:

getDirectGroupIds in interface ICustomPlayerConfigGroupDataAPI

Returns:

the set of directly included group IDs, not null

playerIdIsIncluded

boolean playerIdIsIncluded(@Nullable
 UUID playerId)

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Checks whether the player with a specified UUID is one of the member entries.

Specified by:

playerIdIsIncluded in interface ICustomPlayerConfigGroupDataAPI

Parameters:

playerId - the ID of the player, not null

Returns:

true if one of the member entries corresponds to the ID, otherwise false

playerNameIsIncluded

boolean playerNameIsIncluded(@Nullable
 String name)

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Checks whether a specified player name is one of the member entries.

Specified by:

playerNameIsIncluded in interface ICustomPlayerConfigGroupDataAPI

Parameters:

name - the player name, can be null

Returns:

true if the specified player name is not null and corresponds to a member entry, otherwise false

groupIdIsIncluded

boolean groupIdIsIncluded(@Nullable
 String groupId)

Description copied from interface: ICustomPlayerConfigGroupDataAPI

Checks whether a specified group ID is included in this group.

Specified by:

groupIdIsIncluded in interface ICustomPlayerConfigGroupDataAPI

Parameters:

groupId - the group ID, can be null

Returns:

true if the specified group ID is not null and corresponds to a group entry, otherwise false

includeMember

@Nonnull
com.mojang.datafixers.util.Either<ICustomPlayerGroupMemberAPI,PlayerConfigGroupActionError> includeMember(@Nullable
 UUID id,
 @Nullable
 String name)

Attempts to include a member in this group using specified UUID or player name.

At least one of the player identified must be non-null.

Parameters:

id - the UUID of the player to include, must not be null if the name is

name - the name of the player to include, must not be null if the id is

Returns:

an Either instance with either the added member entry on the left or an error on the right PlayerConfigGroupActionError

includeMemberLimited

@Nonnull
com.mojang.datafixers.util.Either<ICustomPlayerGroupMemberAPI,PlayerConfigGroupActionError> includeMemberLimited(@Nullable
 UUID id,
 @Nullable
 String name)

Attempts to include a member in this group using specified UUID or player name.

Unlike includeMember(UUID, String), this method takes additional limitations into account, such as the player group space available for non-op players.

At least one of the player identified must be non-null.

Parameters:

id - the UUID of the player to include, must not be null if the name is

name - the name of the player to include, must not be null if the id is

Returns:

an Either instance with either the added member entry on the left or an error on the right PlayerConfigGroupActionError

excludeMember

@Nonnull
Optional<PlayerConfigGroupActionError> excludeMember(@Nonnull
 ICustomPlayerGroupMemberAPI member)

Attempts to exclude a specified member entry from this group.

Parameters:

member - the member entry, not null

Returns:

an Optional error PlayerConfigGroupActionError

excludeMember

@Nonnull
Optional<PlayerConfigGroupActionError> excludeMember(@Nullable
 UUID id,
 @Nullable
 String name)

Attempts to exclude the member entry with a specified UUID and/or name from this group.

Parameters:

id - the player UUID of the member entry, can be null

name - the player name of the member entry, can be null

Returns:

an Optional error PlayerConfigGroupActionError

includeGroup

@Nonnull
Optional<PlayerConfigGroupActionError> includeGroup(@Nonnull
 String groupId)

Attempts to include the group with a specified ID in this group.

Parameters:

groupId - the ID of the group to include, not null

Returns:

an Optional error PlayerConfigGroupActionError

includeGroupLimited

@Nonnull
Optional<PlayerConfigGroupActionError> includeGroupLimited(@Nonnull
 String groupId)

Attempts to include the group with a specified ID in this group.

Unlike includeGroup(String), this method takes additional limitations into account, such as the player group space available for non-op players.

Parameters:

groupId - the ID of the group to include, not null

Returns:

an Optional error PlayerConfigGroupActionError

excludeGroup

@Nonnull
Optional<PlayerConfigGroupActionError> excludeGroup(@Nonnull
 String groupId)

Attempts to exclude the group with a specified ID from this group.

Parameters:

groupId - the ID of the group to exclude, not null

Returns:

an Optional error PlayerConfigGroupActionError