de.flapdoodle.graph

Class ImmutableLoop<V,E>

java.lang.Object

de.flapdoodle.graph.ImmutableLoop<V,E>

All Implemented Interfaces:

Loop<V,E>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableLoop<V,E>
extends Object
implements Loop<V,E>

Immutable implementation of Loop.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableLoop.Builder<V,E> Builds instances of type ImmutableLoop.

Method Summary

Modifier and Type	Method and Description
static <V,E> ImmutableLoop.Builder<V,E>	builder() Creates a builder for ImmutableLoop.
static <V,E> ImmutableLoop<V,E>	copyOf(Loop<V,E> instance) Creates an immutable copy of a Loop value.
Set<Edge<V,E>>	edges()
boolean	equals(Object another) This instance is equal to all instances of ImmutableLoop that have equal attribute values.
int	hashCode() Computes a hash code from attributes: edges.
String	toString() Prints the immutable value Loop with attribute values.
Set<V>	vertexSet() Returns a lazily initialized value of the vertexSet attribute.
ImmutableLoop<V,E>	withEdges(Edge<V,E>... elements) Copy the current immutable object with elements that replace the content of edges.
ImmutableLoop<V,E>	withEdges(Iterable<? extends Edge<V,E>> elements) Copy the current immutable object with elements that replace the content of edges.

Methods inherited from class java.lang.Object

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

Method Detail

edges

public Set<Edge<V,E>> edges()

Specified by:

edges in interface Loop<V,E>

Returns:

The value of the edges attribute

withEdges

@SafeVarargs
public final ImmutableLoop<V,E> withEdges(Edge<V,E>... elements)

Copy the current immutable object with elements that replace the content of edges.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withEdges

public final ImmutableLoop<V,E> withEdges(Iterable<? extends Edge<V,E>> elements)

Copy the current immutable object with elements that replace the content of edges. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of edges elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableLoop 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: edges.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Loop with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

vertexSet

public Set<V> vertexSet()

Returns a lazily initialized value of the vertexSet attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

vertexSet in interface Loop<V,E>

Returns:

A lazily initialized value of the vertexSet attribute

copyOf

public static <V,E> ImmutableLoop<V,E> copyOf(Loop<V,E> instance)

Creates an immutable copy of a Loop 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:

V - generic parameter V

E - generic parameter E

Parameters:

instance - The instance to copy

Returns:

A copied immutable Loop instance

builder

public static <V,E> ImmutableLoop.Builder<V,E> builder()

Creates a builder for ImmutableLoop.

 ImmutableLoop.<V, E>builder()
    .addEdges|addAllEdges(de.flapdoodle.graph.Edge<V, E>) // edges elements
    .build();
 

Type Parameters:

V - generic parameter V

E - generic parameter E

Returns:

A new ImmutableLoop builder