io.spine.client

Class ActorRequestFactory.Builder

java.lang.Object

io.spine.client.ActorRequestFactory.Builder

Enclosing class:

ActorRequestFactory

public static class ActorRequestFactory.Builder
extends java.lang.Object

A builder for ActorRequestFactory.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ActorRequestFactory	build() Ensures that all the Builder parameters are set properly.
io.spine.core.UserId	getActor()
@Nullable io.spine.core.TenantId	getTenantId() Obtains the ID of the tenant in a multi-tenant application to which the actor belongs.
@Nullable io.spine.time.ZoneId	getZoneId() Obtains the zone ID set in the builder.
@Nullable io.spine.time.ZoneOffset	getZoneOffset() Obtains the zone offset set in the builder.
ActorRequestFactory.Builder	setActor(io.spine.core.UserId actor) Sets the ID for the user generating commands.
ActorRequestFactory.Builder	setTenantId(@Nullable io.spine.core.TenantId tenantId) Sets the ID of a tenant in a multi-tenant application to which the actor belongs.
ActorRequestFactory.Builder	setZoneId(io.spine.time.ZoneId zoneId) Sets the ID of the time zone in which the user works.
ActorRequestFactory.Builder	setZoneOffset(io.spine.time.ZoneOffset zoneOffset) Sets the offset of the time zone in which the user works.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

getActor

public io.spine.core.UserId getActor()

setActor

@CanIgnoreReturnValue
public ActorRequestFactory.Builder setActor(io.spine.core.UserId actor)

Sets the ID for the user generating commands.

Parameters:

actor - the ID of the user generating commands

getZoneOffset

public @Nullable io.spine.time.ZoneOffset getZoneOffset()

Obtains the zone offset set in the builder.

Returns:

the zone offset or null if the value was not set

setZoneOffset

@CanIgnoreReturnValue
public ActorRequestFactory.Builder setZoneOffset(io.spine.time.ZoneOffset zoneOffset)

Sets the offset of the time zone in which the user works.

Parameters:

zoneOffset - the offset of the time zone the user works in

getZoneId

public @Nullable io.spine.time.ZoneId getZoneId()

Obtains the zone ID set in the builder.

Returns:

the zone ID or null if the value was not set

setZoneId

@CanIgnoreReturnValue
public ActorRequestFactory.Builder setZoneId(io.spine.time.ZoneId zoneId)

Sets the ID of the time zone in which the user works.

Parameters:

zoneId - the

getTenantId

public @Nullable io.spine.core.TenantId getTenantId()

Obtains the ID of the tenant in a multi-tenant application to which the actor belongs.

Returns:

the ID of the tenant or null for a single-tenant execution context

setTenantId

@CanIgnoreReturnValue
public ActorRequestFactory.Builder setTenantId(@Nullable io.spine.core.TenantId tenantId)

Sets the ID of a tenant in a multi-tenant application to which the actor belongs.

Parameters:

tenantId - the ID of the tenant or null for single-tenant execution context

build

public ActorRequestFactory build()

Ensures that all the Builder parameters are set properly.

Initializes zoneOffset and zoneId with default values if they are not defined.

Returns:

a new instance of the factory