Package eu.cloudnetservice.driver.permission

Class Permission.Builder

java.lang.Object

eu.cloudnetservice.driver.permission.Permission.Builder

Enclosing class:

Permission

public static class Permission.Builder
extends Object

A builder for a Permission.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	name
private int	potency
private long	timeOutMillis

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull Permission	build()	Builds the new permission with all previously set options.
@NonNull Permission.Builder	name(@NonNull String name)	Sets the name of this permission.
@NonNull Permission.Builder	potency(int potency)	Sets the potency of this permission.
@NonNull Permission.Builder	timeOutMillis(long timeOutMillis)	Sets the given milliseconds to the absolute time at which this permission should expire.
@NonNull Permission.Builder	timeOutMillis(@NonNull TimeUnit unit, long timeOut)	Sets the given time-out to the absolute time at which this permission should expire.

Methods inherited from class java.lang.Object

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

Field Details

name

private String name

potency

private int potency

timeOutMillis

private long timeOutMillis

Constructor Details

Builder

public Builder()

Method Details

name

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

Sets the name of this permission.

Parameters:

name - the name of the permission.

Returns:

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

Throws:

NullPointerException - if the given name is null.

potency

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

Sets the potency of this permission.

Parameters:

potency - the potency of this permission

Returns:

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

timeOutMillis

@NonNull
public @NonNull Permission.Builder timeOutMillis(long timeOutMillis)

Sets the given milliseconds to the absolute time at which this permission should expire.

Parameters:

timeOutMillis - the time-out for this permission.

Returns:

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

timeOutMillis

@NonNull
public @NonNull Permission.Builder timeOutMillis(@NonNull
 @NonNull TimeUnit unit,
 long timeOut)

Sets the given time-out to the absolute time at which this permission should expire. The time-out is added to the current time millis System.currentTimeMillis().

Parameters:

unit - the unit of the given time out.

timeOut - the time-out for this permission.

Returns:

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

Throws:

NullPointerException - if the given unit is null.

build

@NonNull
public @NonNull Permission build()

Builds the new permission with all previously set options.

Returns:

the new permission.

Throws:

NullPointerException - if the name of the permission is missing.