Package eu.cloudnetservice.driver.permission

Class PermissionGroup.Builder

java.lang.Object

eu.cloudnetservice.driver.permission.PermissionGroup.Builder

All Implemented Interfaces:

DefaultedDocPropertyHolder, DefaultedDocPropertyHolder.Mutable<PermissionGroup.Builder>, DefaultedDocPropertyHolder.Mutable.WithDirectModifier<PermissionGroup.Builder>, DocPropertyHolder, DocPropertyHolder.Mutable<PermissionGroup.Builder>

Enclosing class:

PermissionGroup

public static final class PermissionGroup.Builder
extends Object
implements DefaultedDocPropertyHolder.Mutable.WithDirectModifier<PermissionGroup.Builder>

A builder for permission groups.

Since:

4.0

Nested Class Summary

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

DefaultedDocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder.Mutable

DefaultedDocPropertyHolder.Mutable.WithDirectModifier<S extends DocPropertyHolder.Mutable<S>>

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DocPropertyHolder

DocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Field Summary

Fields

Modifier and Type	Field	Description
private String	color
private boolean	defaultGroup
private String	display
private Map<String,Set<Permission>>	groupPermissions
private Set<String>	groups
private String	name
private Set<Permission>	permissions
private int	potency
private String	prefix
private Document.Mutable	properties
private int	sortId
private String	suffix

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull PermissionGroup.Builder	addGroup(@NonNull PermissionGroup group)	Adds the given group to the parent groups of the permission group.
@NonNull PermissionGroup.Builder	addPermission(@NonNull Permission permission)	Adds the given permission to the permissions of the group.
@NonNull PermissionGroup	build()	Constructs the new permission group from this builder.
@NonNull PermissionGroup.Builder	color(@NonNull String color)	Sets the color of the permission group.
@NonNull PermissionGroup.Builder	defaultGroup(boolean defaultGroup)	Sets whether the permission group is the default group or not.
@NonNull PermissionGroup.Builder	display(@NonNull String display)	Sets the display of the permission group.
@NonNull PermissionGroup.Builder	groupPermissions(@NonNull Map<String,Set<Permission>> groupPermissions)	Sets the group permissions of the permission group.
@NonNull PermissionGroup.Builder	groups(@NonNull Collection<String> groups)	Sets the parent groups of the permission group.
@NonNull PermissionGroup.Builder	name(@NonNull String name)	Sets the required name of the permission group.
@NonNull PermissionGroup.Builder	permissions(@NonNull Collection<Permission> permissions)	Sets the permissions of the permission group.
@NonNull PermissionGroup.Builder	potency(int potency)	Sets the potency of the permission group.
@NonNull PermissionGroup.Builder	prefix(@NonNull String prefix)	Sets the prefix of the permission group.
@NonNull PermissionGroup.Builder	properties(@NonNull Document properties)	Sets the properties of the permission group.
Document.Mutable	propertyHolder()	Get the underlying document that all read and write operations are delegated to.
@NonNull PermissionGroup.Builder	sortId(int sortId)	Sets the sort id of the permission group.
@NonNull PermissionGroup.Builder	suffix(@NonNull String suffix)	Sets the suffix of the permission group.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder.Mutable

removeProperty, writeProperty, writePropertyIfAbsent, writePropertyIfAbsent, writePropertyIfPresent, writePropertyIfPresent

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder.Mutable.WithDirectModifier

modifyAndSetProperties, modifyProperties

Field Details

name

private String name

potency

private int potency

color

private String color

prefix

private String prefix

suffix

private String suffix

display

private String display

sortId

private int sortId

defaultGroup

private boolean defaultGroup

groups

private Set<String> groups

permissions

private Set<Permission> permissions

properties

private Document.Mutable properties

groupPermissions

private Map<String,Set<Permission>> groupPermissions

Constructor Details

Builder

public Builder()

Method Details

name

@NonNull
public @NonNull PermissionGroup.Builder name(@NonNull
 @NonNull String name)

Sets the required name of the permission group.

Parameters:

name - the name of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given name is null.

potency

@NonNull
public @NonNull PermissionGroup.Builder potency(int potency)

Sets the potency of the permission group.

Parameters:

potency - the potency of the new group.

Returns:

the same instance as used to call the method, for chaining.

color

@NonNull
public @NonNull PermissionGroup.Builder color(@NonNull
 @NonNull String color)

Sets the color of the permission group.

Parameters:

color - the color of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given color is null.

prefix

@NonNull
public @NonNull PermissionGroup.Builder prefix(@NonNull
 @NonNull String prefix)

Sets the prefix of the permission group.

Parameters:

prefix - the prefix of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given prefix is null.

suffix

@NonNull
public @NonNull PermissionGroup.Builder suffix(@NonNull
 @NonNull String suffix)

Sets the suffix of the permission group.

Parameters:

suffix - the suffix of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given suffix is null.

display

@NonNull
public @NonNull PermissionGroup.Builder display(@NonNull
 @NonNull String display)

Sets the display of the permission group.

Parameters:

display - the display of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given display is null.

sortId

@NonNull
public @NonNull PermissionGroup.Builder sortId(int sortId)

Sets the sort id of the permission group.

Parameters:

sortId - the sort id of the new group.

Returns:

the same instance as used to call the method, for chaining.

defaultGroup

@NonNull
public @NonNull PermissionGroup.Builder defaultGroup(boolean defaultGroup)

Sets whether the permission group is the default group or not.

Parameters:

defaultGroup - whether the permission group is the default group or not.

Returns:

the same instance as used to call the method, for chaining.

addGroup

@NonNull
public @NonNull PermissionGroup.Builder addGroup(@NonNull
 @NonNull PermissionGroup group)

Adds the given group to the parent groups of the permission group.

Parameters:

group - the parent group to add.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given group is null.

groups

@NonNull
public @NonNull PermissionGroup.Builder groups(@NonNull
 @NonNull Collection<String> groups)

Sets the parent groups of the permission group.

Parameters:

groups - the parent groups of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given group collection is null.

addPermission

@NonNull
public @NonNull PermissionGroup.Builder addPermission(@NonNull
 @NonNull Permission permission)

Adds the given permission to the permissions of the group.

Parameters:

permission - the permission to add.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given permission is null.

permissions

@NonNull
public @NonNull PermissionGroup.Builder permissions(@NonNull
 @NonNull Collection<Permission> permissions)

Sets the permissions of the permission group.

Parameters:

permissions - the permissions of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given permissions are null.

groupPermissions

@NonNull
public @NonNull PermissionGroup.Builder groupPermissions(@NonNull
 @NonNull Map<String,Set<Permission>> groupPermissions)

Sets the group permissions of the permission group.

Parameters:

groupPermissions - the group permissions for the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given group permissions are null.

properties

@NonNull
public @NonNull PermissionGroup.Builder properties(@NonNull
 @NonNull Document properties)

Sets the properties of the permission group.

Parameters:

properties - the properties of the new group.

Returns:

the same instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given properties are null.

propertyHolder

@NonNull
public Document.Mutable propertyHolder()

Get the underlying document that all read and write operations are delegated to.

Specified by:

propertyHolder in interface DocPropertyHolder

Specified by:

propertyHolder in interface DocPropertyHolder.Mutable<PermissionGroup.Builder>

Returns:

the underlying document.

build

@NonNull
public @NonNull PermissionGroup build()

Constructs the new permission group from this builder.

Returns:

the new permission group.

Throws:

NullPointerException - if the name is missing.