de.flapdoodle.os.common.attributes

Class ImmutableTextFile.Builder

java.lang.Object

de.flapdoodle.os.common.attributes.ImmutableTextFile.Builder

Enclosing class:

ImmutableTextFile

public static final class ImmutableTextFile.Builder
extends Object

Builds instances of type ImmutableTextFile. 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 and Description
ImmutableTextFile	build() Builds a new ImmutableTextFile.
ImmutableTextFile.Builder	charset(Charset charset) Initializes the value for the charset attribute.
ImmutableTextFile.Builder	from(TextFile instance) Fill a builder with attribute values from the provided TextFile instance.
ImmutableTextFile.Builder	name(String name) Initializes the value for the name attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableTextFile.Builder from(TextFile instance)

Fill a builder with attribute values from the provided TextFile 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

name

public final ImmutableTextFile.Builder name(String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

charset

public final ImmutableTextFile.Builder charset(Charset charset)

Initializes the value for the charset attribute.

If not set, this attribute will have a default value as returned by the initializer of charset.

Parameters:

charset - The value for charset

Returns:

this builder for use in a chained invocation

build

public ImmutableTextFile build()

Builds a new ImmutableTextFile.

Returns:

An immutable instance of TextFile

Throws:

IllegalStateException - if any required attributes are missing