Package org.javacord.api.entity.permission

Class PermissionsBuilder

java.lang.Object

org.javacord.api.entity.permission.PermissionsBuilder

public class PermissionsBuilder
extends java.lang.Object

A class to create permissions objects.

Constructor Summary

Constructors

Constructor	Description
PermissionsBuilder()	Creates a new permissions builder with all types set to PermissionState.UNSET.
PermissionsBuilder(Permissions permissions)	Creates a new permissions builder with the states of the given permissions object.

Method Summary

Modifier and Type	Method	Description
Permissions	build()	Creates a Permissions instance with the given values.
PermissionState	getState(PermissionType type)	Gets the state of the given type.
PermissionsBuilder	setAllAllowed()	Sets all states to PermissionState.ALLOWED.
PermissionsBuilder	setAllDenied()	Sets all states to PermissionState.DENIED.
PermissionsBuilder	setAllowed(PermissionType... types)	Sets the state for the given types to PermissionState.ALLOWED.
PermissionsBuilder	setAllUnset()	Sets all states to PermissionState.UNSET.
PermissionsBuilder	setDenied(PermissionType... types)	Sets the state for the given types to PermissionState.DENIED.
PermissionsBuilder	setState(PermissionType type, PermissionState state)	Sets the new state of the given type.
PermissionsBuilder	setUnset(PermissionType... types)	Sets the state for the given types to PermissionState.UNSET.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PermissionsBuilder

public PermissionsBuilder()

Creates a new permissions builder with all types set to PermissionState.UNSET.

PermissionsBuilder

public PermissionsBuilder(Permissions permissions)

Creates a new permissions builder with the states of the given permissions object.

Parameters:

permissions - The permissions which should be copied.

Method Detail

setState

public PermissionsBuilder setState(PermissionType type,
                                   PermissionState state)

Sets the new state of the given type.

Parameters:

type - The type to change.

state - The state to set.

Returns:

The current instance in order to chain call methods.

setAllowed

public PermissionsBuilder setAllowed(PermissionType... types)

Sets the state for the given types to PermissionState.ALLOWED.

Parameters:

types - The types to change.

Returns:

The current instance in order to chain call methods.

setAllAllowed

public PermissionsBuilder setAllAllowed()

Sets all states to PermissionState.ALLOWED.

Returns:

The current instance in order to chain call methods.

setDenied

public PermissionsBuilder setDenied(PermissionType... types)

Sets the state for the given types to PermissionState.DENIED.

Parameters:

types - The types to change.

Returns:

The current instance in order to chain call methods.

setAllDenied

public PermissionsBuilder setAllDenied()

Sets all states to PermissionState.DENIED.

Returns:

The current instance in order to chain call methods.

setUnset

public PermissionsBuilder setUnset(PermissionType... types)

Sets the state for the given types to PermissionState.UNSET.

Parameters:

types - The types to change.

Returns:

The current instance in order to chain call methods.

setAllUnset

public PermissionsBuilder setAllUnset()

Sets all states to PermissionState.UNSET.

Returns:

The current instance in order to chain call methods.

getState

public PermissionState getState(PermissionType type)

Gets the state of the given type.

Parameters:

type - The type to check.

Returns:

The state of the given type.

build

public Permissions build()

Creates a Permissions instance with the given values.

Returns:

The created permissions instance.