net.bubuntu.graph

Interface Vertices<TypeVertex extends java.lang.Comparable<TypeVertex>,TypeVertexReal extends Vertex<TypeVertex>>

Type Parameters:

TypeVertex - The type of values stored in the vertices. Must be a Comparable type.

TypeVertexReal - The real type of vertices. Must inherits Vertex.

All Superinterfaces:

BubuntuGraph, java.util.Collection<TypeVertexReal>, java.lang.Iterable<TypeVertexReal>, java.util.Set<TypeVertexReal>

All Known Subinterfaces:

VerticesDirected<TypeVertex>, VerticesUndirected<TypeVertex>

public interface Vertices<TypeVertex extends java.lang.Comparable<TypeVertex>,TypeVertexReal extends Vertex<TypeVertex>>
extends java.util.Set<TypeVertexReal>, BubuntuGraph

Top-level interface of vertex sets.

Version:

2013.11.27

Author:

Rémi Vernay (remi.vernay@bubuntu.net)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(TypeVertex... vertices) Add new vertices in the graph.
boolean	add(TypeVertex vertex) Add a new vertex in the graph.
boolean	contains(TypeVertex vertex) Returns true if this set contains the specified vertex.
TypeVertexReal	get(TypeVertex vertex) Get the specified vertex.
boolean	remove(TypeVertex vertex) Remove the specified vertex from the set.

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

add

boolean add(TypeVertex vertex)

Add a new vertex in the graph.

Parameters:

vertex - The new vertex.

Returns:

True if this set changed as a result of the call.

add

boolean add(TypeVertex... vertices)

Add new vertices in the graph.

Parameters:

vertices - The new vertices to add in the graph.

Returns:

True if all the vertices were added.

contains

boolean contains(TypeVertex vertex)

Returns true if this set contains the specified vertex.

Parameters:

vertex - The vertex to find.

Returns:

True if this set contains the specified element

get

TypeVertexReal get(TypeVertex vertex)
                                              throws EGraphIncorrectVertex

Get the specified vertex.

Parameters:

vertex - The vertex to give.

Returns:

The given vertex.

Throws:

EGraphIncorrectVertex - If no vertex matching.

remove

boolean remove(TypeVertex vertex)

Remove the specified vertex from the set.

Parameters:

vertex - The vertex to remove.

Returns:

True if this set changed as a result of the call.