de.flapdoodle.graph

Class ImmutableEdge<V,E>

java.lang.Object

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

All Implemented Interfaces:

Edge<V,E>

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

Immutable implementation of Edge.

Use the builder to create immutable instances: ImmutableEdge.builder(). Use the static factory method to create immutable instances: ImmutableEdge.of().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <V,E> ImmutableEdge.Builder<V,E>	builder() Creates a builder for ImmutableEdge.
static <V,E> ImmutableEdge<V,E>	copyOf(Edge<V,E> instance) Creates an immutable copy of a Edge value.
E	edge()
V	end()
boolean	equals(Object another) This instance is equal to all instances of ImmutableEdge that have equal attribute values.
int	hashCode() Computes a hash code from attributes: start, end, edge.
static <V,E> ImmutableEdge<V,E>	of(V start, V end, E edge) Construct a new immutable Edge instance.
V	start()
String	toString() Prints the immutable value Edge with attribute values.
ImmutableEdge<V,E>	withEdge(E value) Copy the current immutable object by setting a value for the edge attribute.
ImmutableEdge<V,E>	withEnd(V value) Copy the current immutable object by setting a value for the end attribute.
ImmutableEdge<V,E>	withStart(V value) Copy the current immutable object by setting a value for the start attribute.

Methods inherited from class java.lang.Object

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

Method Detail

start

public V start()

Specified by:

start in interface Edge<V,E>

Returns:

The value of the start attribute

end

public V end()

Specified by:

end in interface Edge<V,E>

Returns:

The value of the end attribute

edge

public E edge()

Specified by:

edge in interface Edge<V,E>

Returns:

The value of the edge attribute

withStart

public final ImmutableEdge<V,E> withStart(V value)

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

Parameters:

value - A new value for start

Returns:

A modified copy of the this object

withEnd

public final ImmutableEdge<V,E> withEnd(V value)

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

Parameters:

value - A new value for end

Returns:

A modified copy of the this object

withEdge

public final ImmutableEdge<V,E> withEdge(E value)

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

Parameters:

value - A new value for edge

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableEdge 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: start, end, edge.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Edge with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <V,E> ImmutableEdge<V,E> of(V start,
                                          V end,
                                          E edge)

Construct a new immutable Edge instance.

Type Parameters:

V - generic parameter V

E - generic parameter E

Parameters:

start - The value for the start attribute

end - The value for the end attribute

edge - The value for the edge attribute

Returns:

An immutable Edge instance

copyOf

public static <V,E> ImmutableEdge<V,E> copyOf(Edge<V,E> instance)

Creates an immutable copy of a Edge 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 Edge instance

builder

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

Creates a builder for ImmutableEdge.

 ImmutableEdge.<V, E>builder()
    .start(V) // required start
    .end(V) // required end
    .edge(E) // required edge
    .build();
 

Type Parameters:

V - generic parameter V

E - generic parameter E

Returns:

A new ImmutableEdge builder