de.flapdoodle.commons.graph

Class ImmutableSubGraph<T>

java.lang.Object

de.flapdoodle.commons.graph.ImmutableSubGraph<T>

All Implemented Interfaces:

GraphAsDot.SubGraph<T>

@Generated(from="GraphAsDot.SubGraph",
           generator="Immutables")
 @Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableSubGraph<T>
extends Object
implements GraphAsDot.SubGraph<T>

Immutable implementation of GraphAsDot.SubGraph.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableSubGraph.Builder<T> Builds instances of type ImmutableSubGraph.

Method Summary

Modifier and Type	Method and Description
static <T> ImmutableSubGraph.Builder<T>	builder(org.jgrapht.Graph<T,?> graph) Creates a builder for ImmutableSubGraph.
Map<T,T>	connections()
static <T> ImmutableSubGraph<T>	copyOf(GraphAsDot.SubGraph<T> instance) Creates an immutable copy of a GraphAsDot.SubGraph value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableSubGraph that have equal attribute values.
org.jgrapht.Graph<T,?>	graph()
int	hashCode() Computes a hash code from attributes: graph, connections.
String	toString() Prints the immutable value SubGraph with attribute values.
ImmutableSubGraph<T>	withConnections(Map<? extends T,? extends T> entries) Copy the current immutable object by replacing the connections map with the specified map.
ImmutableSubGraph<T>	withGraph(org.jgrapht.Graph<T,?> value) Copy the current immutable object by setting a value for the graph attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.flapdoodle.commons.graph.GraphAsDot.SubGraph

of

Method Detail

graph

public org.jgrapht.Graph<T,?> graph()

Specified by:

graph in interface GraphAsDot.SubGraph<T>

Returns:

The value of the graph attribute

connections

public Map<T,T> connections()

Specified by:

connections in interface GraphAsDot.SubGraph<T>

Returns:

The value of the connections attribute

withGraph

public final ImmutableSubGraph<T> withGraph(org.jgrapht.Graph<T,?> value)

Copy the current immutable object by setting a value for the graph attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for graph

Returns:

A modified copy or the this object

withConnections

public final ImmutableSubGraph<T> withConnections(Map<? extends T,? extends T> entries)

Copy the current immutable object by replacing the connections map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to replace the connections map

Returns:

A modified copy or this if not changed

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableSubGraph 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: graph, connections.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SubGraph with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <T> ImmutableSubGraph<T> copyOf(GraphAsDot.SubGraph<T> instance)

Creates an immutable copy of a GraphAsDot.SubGraph 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 SubGraph instance

builder

public static <T> ImmutableSubGraph.Builder<T> builder(org.jgrapht.Graph<T,?> graph)

Creates a builder for ImmutableSubGraph.

 ImmutableSubGraph.<T>builder()
    .graph(org.jgrapht.Graph<T, ?>) // required graph
    .putConnections|putAllConnections(T => T) // connections mappings
    .build();
 

Type Parameters:

T - generic parameter T

Parameters:

graph - graph parameter

Returns:

A new ImmutableSubGraph builder