de.flapdoodle.graph

Class ImmutableGraphAsDot.Builder<T>

java.lang.Object

de.flapdoodle.graph.ImmutableGraphAsDot.Builder<T>

Enclosing class:

ImmutableGraphAsDot<T>

public static final class ImmutableGraphAsDot.Builder<T>
extends Object

Builds instances of type ImmutableGraphAsDot. 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
ImmutableGraphAsDot<T>	build() Builds a new ImmutableGraphAsDot.
ImmutableGraphAsDot.Builder<T>	edgeAttributes(BiFunction<T,T,Map<String,String>> edgeAttributes) Initializes the value for the edgeAttributes attribute.
ImmutableGraphAsDot.Builder<T>	from(GraphAsDot<T> instance) Fill a builder with attribute values from the provided GraphAsDot instance.
ImmutableGraphAsDot.Builder<T>	label(String label) Initializes the value for the label attribute.
ImmutableGraphAsDot.Builder<T>	nodeAsLabel(Function<T,String> nodeAsLabel) Initializes the value for the nodeAsLabel attribute.
ImmutableGraphAsDot.Builder<T>	nodeAttributes(Function<T,Map<String,String>> nodeAttributes) Initializes the value for the nodeAttributes attribute.
ImmutableGraphAsDot.Builder<T>	sortedBy(GraphAsDot.AsComparable<T,?> sortedBy) Initializes the optional value sortedBy to sortedBy.
ImmutableGraphAsDot.Builder<T>	sortedBy(Optional<? extends GraphAsDot.AsComparable<T,?>> sortedBy) Initializes the optional value sortedBy to sortedBy.
ImmutableGraphAsDot.Builder<T>	subGraph(Function<T,Optional<GraphAsDot.SubGraph<T>>> subGraph) Initializes the value for the subGraph attribute.
ImmutableGraphAsDot.Builder<T>	subGraphIdSeparator(String subGraphIdSeparator) Initializes the value for the subGraphIdSeparator attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableGraphAsDot.Builder<T> from(GraphAsDot<T> instance)

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

subGraphIdSeparator

public final ImmutableGraphAsDot.Builder<T> subGraphIdSeparator(String subGraphIdSeparator)

Initializes the value for the subGraphIdSeparator attribute.

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

Parameters:

subGraphIdSeparator - The value for subGraphIdSeparator

Returns:

this builder for use in a chained invocation

nodeAsLabel

public final ImmutableGraphAsDot.Builder<T> nodeAsLabel(Function<T,String> nodeAsLabel)

Initializes the value for the nodeAsLabel attribute.

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

Parameters:

nodeAsLabel - The value for nodeAsLabel

Returns:

this builder for use in a chained invocation

edgeAttributes

public final ImmutableGraphAsDot.Builder<T> edgeAttributes(BiFunction<T,T,Map<String,String>> edgeAttributes)

Initializes the value for the edgeAttributes attribute.

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

Parameters:

edgeAttributes - The value for edgeAttributes

Returns:

this builder for use in a chained invocation

nodeAttributes

public final ImmutableGraphAsDot.Builder<T> nodeAttributes(Function<T,Map<String,String>> nodeAttributes)

Initializes the value for the nodeAttributes attribute.

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

Parameters:

nodeAttributes - The value for nodeAttributes

Returns:

this builder for use in a chained invocation

subGraph

public final ImmutableGraphAsDot.Builder<T> subGraph(Function<T,Optional<GraphAsDot.SubGraph<T>>> subGraph)

Initializes the value for the subGraph attribute.

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

Parameters:

subGraph - The value for subGraph

Returns:

this builder for use in a chained invocation

sortedBy

public final ImmutableGraphAsDot.Builder<T> sortedBy(GraphAsDot.AsComparable<T,?> sortedBy)

Initializes the optional value sortedBy to sortedBy.

Parameters:

sortedBy - The value for sortedBy

Returns:

this builder for chained invocation

sortedBy

public final ImmutableGraphAsDot.Builder<T> sortedBy(Optional<? extends GraphAsDot.AsComparable<T,?>> sortedBy)

Initializes the optional value sortedBy to sortedBy.

Parameters:

sortedBy - The value for sortedBy

Returns:

this builder for use in a chained invocation

label

public final ImmutableGraphAsDot.Builder<T> label(String label)

Initializes the value for the label attribute.

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

Parameters:

label - The value for label

Returns:

this builder for use in a chained invocation

build

public ImmutableGraphAsDot<T> build()

Builds a new ImmutableGraphAsDot.

Returns:

An immutable instance of GraphAsDot

Throws:

IllegalStateException - if any required attributes are missing