io.github.mrblobman.nbt.plugin

Enum NBTProxy.Permissions

java.lang.Object

java.lang.Enum<NBTProxy.Permissions>

io.github.mrblobman.nbt.plugin.NBTProxy.Permissions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NBTProxy.Permissions>

Enclosing class:

NBTProxy

public static enum NBTProxy.Permissions
extends java.lang.Enum<NBTProxy.Permissions>

A list of the permissions for the /nbt command.

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ_BLOCK Required for executing: /nbt get block
READ_ENTITY Required for executing: /nbt get entity /nbt get player <name>
READ_FILE Required for executing: /nbt get file <path>
READ_ITEM Required for executing: /nbt get item
WRITE_BLOCK Required for executing: /nbt set block <nbt-data> /nbt write block <nbt-data> /nbt add block <nbt-data>
WRITE_ENTITY Required for executing: /nbt set entity <nbt-data> /nbt write entity <nbt-data> /nbt add entity <nbt-data> /nbt set player <name> <nbt-data> /nbt write player <name> <nbt-data> /nbt add player <name> <nbt-data>
WRITE_FILE Required for executing: /nbt set file <path> <nbt-data> /nbt write file <path> <nbt-data> /nbt add file <path> <nbt-data>
WRITE_ITEM Required for executing: /nbt set item <nbt-data> /nbt write item <nbt-data> /nbt add item <nbt-data>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	CONFIG_KEY The relative path from 'enabled-commands' to the config key for setting the enabled state of the query this permission guards.
int	PERM_ENABLED_FLAG A unique key for use in an 'enabled' bit set.
java.lang.String	PERMISSION The full name of the permission that a Permissible must have to execute the query this permission guards.

Method Summary

Modifier and Type	Method and Description
static NBTProxy.Permissions	get(java.lang.String queryType, java.lang.String queryTarget) Lookup a permission based on the queryType and queryTarget
static NBTProxy.Permissions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NBTProxy.Permissions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READ_ITEM

public static final NBTProxy.Permissions READ_ITEM

Required for executing:

• /nbt get item

READ_BLOCK

public static final NBTProxy.Permissions READ_BLOCK

Required for executing:

• /nbt get block

READ_ENTITY

public static final NBTProxy.Permissions READ_ENTITY

Required for executing:

• /nbt get entity
• /nbt get player <name>

READ_FILE

public static final NBTProxy.Permissions READ_FILE

Required for executing:

• /nbt get file <path>

WRITE_ITEM

public static final NBTProxy.Permissions WRITE_ITEM

Required for executing:

• /nbt set item <nbt-data>
• /nbt write item <nbt-data>
• /nbt add item <nbt-data>

WRITE_BLOCK

public static final NBTProxy.Permissions WRITE_BLOCK

Required for executing:

• /nbt set block <nbt-data>
• /nbt write block <nbt-data>
• /nbt add block <nbt-data>

WRITE_ENTITY

public static final NBTProxy.Permissions WRITE_ENTITY

Required for executing:

• /nbt set entity <nbt-data>
• /nbt write entity <nbt-data>
• /nbt add entity <nbt-data>
• /nbt set player <name> <nbt-data>
• /nbt write player <name> <nbt-data>
• /nbt add player <name> <nbt-data>

WRITE_FILE

public static final NBTProxy.Permissions WRITE_FILE

Required for executing:

• /nbt set file <path> <nbt-data>
• /nbt write file <path> <nbt-data>
• /nbt add file <path> <nbt-data>

Field Detail

PERM_ENABLED_FLAG

public final int PERM_ENABLED_FLAG

A unique key for use in an 'enabled' bit set.

PERMISSION

public final java.lang.String PERMISSION

The full name of the permission that a Permissible must have to execute the query this permission guards.

CONFIG_KEY

public final java.lang.String CONFIG_KEY

The relative path from 'enabled-commands' to the config key for setting the enabled state of the query this permission guards.

Method Detail

values

public static NBTProxy.Permissions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NBTProxy.Permissions c : NBTProxy.Permissions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NBTProxy.Permissions valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static NBTProxy.Permissions get(java.lang.String queryType,
                                       java.lang.String queryTarget)

Lookup a permission based on the queryType and queryTarget

Parameters:

queryType - the type of the query. One of get, read, set, write, and add

queryTarget - the target of the query. One of item, block, entity, and file

Returns:

the associated permission or null if and unknown queryType or queryTarget