ImmutableGraphAsDot (Flapdoodle Graph Stuff 1.2.3 API)

java.lang.Object
- de.flapdoodle.graph.GraphAsDot<T>
- - de.flapdoodle.graph.ImmutableGraphAsDot<T>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableGraphAsDot<T>
extends GraphAsDot<T>

Immutable implementation of GraphAsDot.

Use the builder to create immutable instances: ImmutableGraphAsDot.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableGraphAsDot.Builder<T>
Builds instances of type ImmutableGraphAsDot.
- Nested classes/interfaces inherited from class de.flapdoodle.graph.GraphAsDot
  GraphAsDot.AsComparable<T,C extends Comparable<C>>, GraphAsDot.SubGraph<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableGraphAsDot.Builder<T>` Builds instances of type `ImmutableGraphAsDot`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> ImmutableGraphAsDot.Builder<T>`	`builder(Function<T,String> nodeAsId)` Creates a builder for `ImmutableGraphAsDot`.
`static <T> ImmutableGraphAsDot<T>`	`copyOf(GraphAsDot<T> instance)` Creates an immutable copy of a `GraphAsDot` value.
`BiFunction<T,T,Map<String,String>>`	`edgeAttributes()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableGraphAsDot` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `nodeAsId`, `subGraphIdSeparator`, `nodeAsLabel`, `edgeAttributes`, `nodeAttributes`, `subGraph`, `sortedBy`, `label`.
`String`	`label()`
`Function<T,String>`	`nodeAsId()`
`Function<T,String>`	`nodeAsLabel()`
`Function<T,Map<String,String>>`	`nodeAttributes()`
`Optional<GraphAsDot.AsComparable<T,?>>`	`sortedBy()`
`Function<T,Optional<GraphAsDot.SubGraph<T>>>`	`subGraph()`
`String`	`subGraphIdSeparator()`
`String`	`toString()` Prints the immutable value `GraphAsDot` with attribute values.
`ImmutableGraphAsDot<T>`	`withEdgeAttributes(BiFunction<T,T,Map<String,String>> value)` Copy the current immutable object by setting a value for the `edgeAttributes` attribute.
`ImmutableGraphAsDot<T>`	`withLabel(String value)` Copy the current immutable object by setting a value for the `label` attribute.
`ImmutableGraphAsDot<T>`	`withNodeAsId(Function<T,String> value)` Copy the current immutable object by setting a value for the `nodeAsId` attribute.
`ImmutableGraphAsDot<T>`	`withNodeAsLabel(Function<T,String> value)` Copy the current immutable object by setting a value for the `nodeAsLabel` attribute.
`ImmutableGraphAsDot<T>`	`withNodeAttributes(Function<T,Map<String,String>> value)` Copy the current immutable object by setting a value for the `nodeAttributes` attribute.
`ImmutableGraphAsDot<T>`	`withSortedBy(GraphAsDot.AsComparable<T,?> value)` Copy the current immutable object by setting a present value for the optional `sortedBy` attribute.
`ImmutableGraphAsDot<T>`	`withSortedBy(Optional<? extends GraphAsDot.AsComparable<T,?>> optional)` Copy the current immutable object by setting an optional value for the `sortedBy` attribute.
`ImmutableGraphAsDot<T>`	`withSubGraph(Function<T,Optional<GraphAsDot.SubGraph<T>>> value)` Copy the current immutable object by setting a value for the `subGraph` attribute.
`ImmutableGraphAsDot<T>`	`withSubGraphIdSeparator(String value)` Copy the current immutable object by setting a value for the `subGraphIdSeparator` attribute.

Methods inherited from class de.flapdoodle.graph.GraphAsDot
asDot

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - nodeAsId
```
public Function<T,String> nodeAsId()
```
    Specified by:
    
    nodeAsId in class GraphAsDot<T>
    
    Returns:
    
    The value of the nodeAsId attribute
  - subGraphIdSeparator
```
public String subGraphIdSeparator()
```
    Overrides:
    
    subGraphIdSeparator in class GraphAsDot<T>
    
    Returns:
    
    The value of the subGraphIdSeparator attribute
  - nodeAsLabel
```
public Function<T,String> nodeAsLabel()
```
    Overrides:
    
    nodeAsLabel in class GraphAsDot<T>
    
    Returns:
    
    The value of the nodeAsLabel attribute
  - edgeAttributes
```
public BiFunction<T,T,Map<String,String>> edgeAttributes()
```
    Overrides:
    
    edgeAttributes in class GraphAsDot<T>
    
    Returns:
    
    The value of the edgeAttributes attribute
  - nodeAttributes
```
public Function<T,Map<String,String>> nodeAttributes()
```
    Overrides:
    
    nodeAttributes in class GraphAsDot<T>
    
    Returns:
    
    The value of the nodeAttributes attribute
  - subGraph
```
public Function<T,Optional<GraphAsDot.SubGraph<T>>> subGraph()
```
    Overrides:
    
    subGraph in class GraphAsDot<T>
    
    Returns:
    
    The value of the subGraph attribute
  - sortedBy
```
public Optional<GraphAsDot.AsComparable<T,?>> sortedBy()
```
    Specified by:
    
    sortedBy in class GraphAsDot<T>
    
    Returns:
    
    The value of the sortedBy attribute
  - label
```
public String label()
```
    Overrides:
    
    label in class GraphAsDot<T>
    
    Returns:
    
    The value of the label attribute
  - withNodeAsId
```
public final ImmutableGraphAsDot<T> withNodeAsId(Function<T,String> value)
```
    Copy the current immutable object by setting a value for the nodeAsId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for nodeAsId
    
    Returns:
    
    A modified copy of the this object
  - withSubGraphIdSeparator
```
public final ImmutableGraphAsDot<T> withSubGraphIdSeparator(String value)
```
    Copy the current immutable object by setting a value for the subGraphIdSeparator attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for subGraphIdSeparator
    
    Returns:
    
    A modified copy of the this object
  - withNodeAsLabel
```
public final ImmutableGraphAsDot<T> withNodeAsLabel(Function<T,String> value)
```
    Copy the current immutable object by setting a value for the nodeAsLabel attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for nodeAsLabel
    
    Returns:
    
    A modified copy of the this object
  - withEdgeAttributes
```
public final ImmutableGraphAsDot<T> withEdgeAttributes(BiFunction<T,T,Map<String,String>> value)
```
    Copy the current immutable object by setting a value for the edgeAttributes attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for edgeAttributes
    
    Returns:
    
    A modified copy of the this object
  - withNodeAttributes
```
public final ImmutableGraphAsDot<T> withNodeAttributes(Function<T,Map<String,String>> value)
```
    Copy the current immutable object by setting a value for the nodeAttributes attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for nodeAttributes
    
    Returns:
    
    A modified copy of the this object
  - withSubGraph
```
public final ImmutableGraphAsDot<T> withSubGraph(Function<T,Optional<GraphAsDot.SubGraph<T>>> value)
```
    Copy the current immutable object by setting a value for the subGraph attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for subGraph
    
    Returns:
    
    A modified copy of the this object
  - withSortedBy
```
public final ImmutableGraphAsDot<T> withSortedBy(GraphAsDot.AsComparable<T,?> value)
```
    Copy the current immutable object by setting a present value for the optional sortedBy attribute.
    
    Parameters:
    
    value - The value for sortedBy
    
    Returns:
    
    A modified copy of this object
  - withSortedBy
```
public final ImmutableGraphAsDot<T> withSortedBy(Optional<? extends GraphAsDot.AsComparable<T,?>> optional)
```
    Copy the current immutable object by setting an optional value for the sortedBy attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for sortedBy
    
    Returns:
    
    A modified copy of this object
  - withLabel
```
public final ImmutableGraphAsDot<T> withLabel(String value)
```
    Copy the current immutable object by setting a value for the label attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for label
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableGraphAsDot that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: nodeAsId, subGraphIdSeparator, nodeAsLabel, edgeAttributes, nodeAttributes, subGraph, sortedBy, label.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value GraphAsDot with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static <T> ImmutableGraphAsDot<T> copyOf(GraphAsDot<T> instance)
```
    Creates an immutable copy of a GraphAsDot value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Type Parameters:
    
    T - generic parameter T
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable GraphAsDot instance
  - builder
```
public static <T> ImmutableGraphAsDot.Builder<T> builder(Function<T,String> nodeAsId)
```
    Creates a builder for ImmutableGraphAsDot.
```
 ImmutableGraphAsDot.&lt;T&gt;builder()
    .nodeAsId(function.Function&lt;T, String&gt;) // required nodeAsId
    .subGraphIdSeparator(String) // optional subGraphIdSeparator
    .nodeAsLabel(function.Function&lt;T, String&gt;) // optional nodeAsLabel
    .edgeAttributes(function.BiFunction&lt;T, T, Map&lt;String, String&gt;&gt;) // optional edgeAttributes
    .nodeAttributes(function.Function&lt;T, Map&lt;String, String&gt;&gt;) // optional nodeAttributes
    .subGraph(function.Function&lt;T, Optional&lt;de.flapdoodle.graph.GraphAsDot.SubGraph&lt;T&gt;&gt;&gt;) // optional subGraph
    .sortedBy(de.flapdoodle.graph.GraphAsDot.AsComparable&lt;T, ?&gt;) // optional sortedBy
    .label(String) // optional label
    .build();
 
```
    Type Parameters:
    
    T - generic parameter T
    
    Parameters:
    
    nodeAsId - nodeAsId parameter
    
    Returns:
    
    A new ImmutableGraphAsDot builder

Class ImmutableGraphAsDot<T>

Nested Class Summary

Nested classes/interfaces inherited from class de.flapdoodle.graph.GraphAsDot

Method Summary

Methods inherited from class de.flapdoodle.graph.GraphAsDot

Methods inherited from class java.lang.Object

Method Detail

nodeAsId

subGraphIdSeparator

nodeAsLabel

edgeAttributes

nodeAttributes

subGraph

sortedBy

label

withNodeAsId

withSubGraphIdSeparator

withNodeAsLabel

withEdgeAttributes

withNodeAttributes

withSubGraph

withSortedBy

withSortedBy

withLabel

equals

hashCode

toString

copyOf

builder