Package io.dialob.client.api

Class ImmutableProgramMessage.Builder

java.lang.Object

io.dialob.client.api.ImmutableProgramMessage.Builder

Enclosing class:

ImmutableProgramMessage

@NotThreadSafe
public static final class ImmutableProgramMessage.Builder
extends Object

Builds instances of type ImmutableProgramMessage. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableProgramMessage	build()	Builds a new ImmutableProgramMessage.
ImmutableProgramMessage.Builder	exception(Exception exception)	Initializes the value for the exception attribute.
ImmutableProgramMessage.Builder	from(DialobClient.ProgramMessage instance)	Fill a builder with attribute values from the provided ProgramMessage instance.
ImmutableProgramMessage.Builder	id(String id)	Initializes the value for the id attribute.
ImmutableProgramMessage.Builder	msg(String msg)	Initializes the value for the msg attribute.
ImmutableProgramMessage.Builder	src(io.dialob.api.form.FormValidationError src)	Initializes the value for the src attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableProgramMessage.Builder from(DialobClient.ProgramMessage instance)

Fill a builder with attribute values from the provided ProgramMessage instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

id

@CanIgnoreReturnValue
public final ImmutableProgramMessage.Builder id(String id)

Initializes the value for the id attribute.

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

msg

@CanIgnoreReturnValue
public final ImmutableProgramMessage.Builder msg(@Nullable
                                                 String msg)

Initializes the value for the msg attribute.

Parameters:

msg - The value for msg (can be null)

Returns:

this builder for use in a chained invocation

src

@CanIgnoreReturnValue
public final ImmutableProgramMessage.Builder src(@Nullable
                                                 io.dialob.api.form.FormValidationError src)

Initializes the value for the src attribute.

Parameters:

src - The value for src (can be null)

Returns:

this builder for use in a chained invocation

exception

@CanIgnoreReturnValue
public final ImmutableProgramMessage.Builder exception(@Nullable
                                                       Exception exception)

Initializes the value for the exception attribute.

Parameters:

exception - The value for exception (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableProgramMessage build()

Builds a new ImmutableProgramMessage.

Returns:

An immutable instance of ProgramMessage

Throws:

IllegalStateException - if any required attributes are missing