Package eu.cloudnetservice.driver.permission

Class PermissionUserGroupInfo.Builder

java.lang.Object

eu.cloudnetservice.driver.permission.PermissionUserGroupInfo.Builder

Enclosing class:

PermissionUserGroupInfo

public static final class PermissionUserGroupInfo.Builder
extends Object

A builder for permission user group infos.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private String	group
private Document	properties
private long	timeOutMillis

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull PermissionUserGroupInfo	build()	Constructs the new permission user group info from this builder.
@NonNull PermissionUserGroupInfo.Builder	group(@NonNull String group)	Sets the group of this group info.
@NonNull PermissionUserGroupInfo.Builder	properties(@NonNull Document properties)	Sets the properties of the new permission user.
@NonNull PermissionUserGroupInfo.Builder	timeOut(long timeout, @NonNull TimeUnit unit)	Sets the given time-out to the absolute time at which this permission should expire.
@NonNull PermissionUserGroupInfo.Builder	timeOut(@NonNull Duration duration)	Sets the time-out for this group info.
@NonNull PermissionUserGroupInfo.Builder	timeOutMillis(long timeOutMillis)	Sets the given milliseconds 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

group

private String group

timeOutMillis

private long timeOutMillis

properties

private Document properties

Constructor Details

Builder

public Builder()

Method Details

group

@NonNull
public @NonNull PermissionUserGroupInfo.Builder group(@NonNull
 @NonNull String group)

Sets the group of this group info.

Parameters:

group - the name of the group info.

Returns:

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

Throws:

NullPointerException - if the given group is null.

timeOutMillis

@NonNull
public @NonNull PermissionUserGroupInfo.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 user group.

Returns:

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

timeOut

@NonNull
public @NonNull PermissionUserGroupInfo.Builder timeOut(long timeout,
 @NonNull
 @NonNull TimeUnit unit)

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:

timeout - the time-out for this group info.

unit - the unit of the given time out.

Returns:

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

Throws:

NullPointerException - if the given unit is null.

timeOut

@NonNull
public @NonNull PermissionUserGroupInfo.Builder timeOut(@NonNull
 @NonNull Duration duration)

Sets the time-out for this group info. The time-out is added to the current time millis System.currentTimeMillis().

Parameters:

duration - the duration the group lasts for.

Returns:

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

Throws:

NullPointerException - if the given duration is null.

properties

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

Sets the properties of the new permission user.

Parameters:

properties - the properties for the new user.

Returns:

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

Throws:

NullPointerException - if the given properties are null.

build

@NonNull
public @NonNull PermissionUserGroupInfo build()

Constructs the new permission user group info from this builder.

Returns:

the new user group info.

Throws:

NullPointerException - if the group name is missing.