io.github.fablabsmc.fablabs.impl.fiber.builder

Class ConfigNodeBuilder

java.lang.Object

io.github.fablabsmc.fablabs.impl.fiber.builder.ConfigNodeBuilder

Direct Known Subclasses:

ConfigLeafBuilder, ConfigTreeBuilder

public abstract class ConfigNodeBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<FiberId,ConfigAttribute<?>>	attributes
protected String	comment
protected String	name
protected ConfigTree	parent

Constructor Summary

Constructors

Constructor and Description
ConfigNodeBuilder(ConfigTree parent, String name)

Method Summary

Modifier and Type	Method and Description
abstract ConfigNode	build() Builds and returns a new ConfigNode with the parent and name stored in this builder.
ConfigNodeBuilder	withAttribute(ConfigAttribute<?> attribute) Adds a single ConfigAttribute to the built ConfigNode.
<A> ConfigNodeBuilder	withAttribute(FiberId id, SerializableType<A> type, A defaultValue) Adds a ConfigAttribute to the built ConfigNode.
ConfigNodeBuilder	withAttributes(Collection<ConfigAttribute<?>> attributes) Adds a collection of ConfigAttribute to the built ConfigNode.
ConfigNodeBuilder	withComment(String comment) Sets the ConfigNode's comment.
ConfigNodeBuilder	withName(String name) Sets the ConfigNode's name.

Methods inherited from class java.lang.Object

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

Field Detail

parent

@Nullable
protected ConfigTree parent

name

@Nullable
protected String name

comment

@Nullable
protected String comment

attributes

protected Map<FiberId,ConfigAttribute<?>> attributes

Constructor Detail

ConfigNodeBuilder

public ConfigNodeBuilder(@Nullable
                         ConfigTree parent,
                         @Nullable
                         String name)

Method Detail

withName

public ConfigNodeBuilder withName(String name)

Sets the ConfigNode's name.

Parameters:

name - the name

Returns:

this builder

See Also:

ConfigTree.lookupLeaf(java.lang.String, io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.SerializableType<T>)

withComment

public ConfigNodeBuilder withComment(String comment)

Sets the ConfigNode's comment.

If null, or if this method is never called, the ConfigNode will not have a comment. An empty comment (non null, but only consisting of whitespace) will be serialised.

Parameters:

comment - the comment

Returns:

this builder

withAttribute

public <A> ConfigNodeBuilder withAttribute(FiberId id,
                                           SerializableType<A> type,
                                           A defaultValue)

Adds a ConfigAttribute to the built ConfigNode.

Type Parameters:

A - the type of values stored in the attribute

Parameters:

id - the id of the attribute

type - the class object representing the type of values stored in the attribute

defaultValue - the attribute's default value

Returns:

this, for chaining

See Also:

ConfigNode.getAttributes()

withAttributes

public ConfigNodeBuilder withAttributes(Collection<ConfigAttribute<?>> attributes)

Adds a collection of ConfigAttribute to the built ConfigNode.

Parameters:

attributes - A collection of attributes.

Returns:

This builder.

withAttribute

public ConfigNodeBuilder withAttribute(ConfigAttribute<?> attribute)

Adds a single ConfigAttribute to the built ConfigNode.

Parameters:

attribute - The attribute.

Returns:

This builder.

build

public abstract ConfigNode build()

Builds and returns a new ConfigNode with the parent and name stored in this builder.