Author: simonetripodi
Date: Sun Jul 3 11:08:29 2011
New Revision: 1142415
URL: http://svn.apache.org/viewvc?rev=1142415&view=rev
Log:
added javadoc comment recommendation for implementors
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java?rev=1142415&r1=1142414&r2=1142415&view=diff
==============================================================================
 commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Graph.java Sun Jul
3 11:08:29 2011
@@ 32,7 +32,10 @@ public interface Graph<V extends Vertex,
/**
* Returns the total set of Vertices in the graph.
 *
+ *
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return the total set of Vertices in the graph.
*/
Iterable<V> getVertices();
@@ 40,13 +43,19 @@ public interface Graph<V extends Vertex,
/**
* Returns the <i>order</i> of a Graph (the number of Vertices);
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return the <i>order</i> of a Graph (the number of Vertices);
*/
int getOrder();
/**
* Returns the total set of Edges in the graph.
 *
+ *
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return the total set of Edges in the graph.
*/
Iterable<E> getEdges();
@@ 54,6 +63,9 @@ public interface Graph<V extends Vertex,
/**
* Returns the <i>size</i> of a Graph (the number of Edges)
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return the <i>size</i> of a Graph (the number of Edges)
*/
int getSize();
@@ 62,6 +74,9 @@ public interface Graph<V extends Vertex,
* The degree (or valency) of a {@link Vertex} of a {@link Graph}
* is the number of {@link Edge}s incident to the {@link Vertex}.
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param v the {@link Vertex} which degree has to be returned.
* @return the number of {@link Edge}s incident to the {@link Vertex}.
*/
@@ 69,14 +84,20 @@ public interface Graph<V extends Vertex,
/**
* Returns all vertices which touch this vertex.
 *
+ *
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return all vertices which touch this vertex.
*/
Iterable<V> getConnectedVertices( V v );
/**
* Returns the edge with vertex source and target.
 *
+ *
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param source the source vertex
* @param target the target vertex
* @return the edge with vertex source and target.
@@ 85,7 +106,10 @@ public interface Graph<V extends Vertex,
/**
* Return the set of {@link Vertex} on the input {@link Edge} (2 for normal edges, >
2 for HyperEdges)
 *
+ *
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @return the set of {@link Vertex} on this Edge.
*/
VertexPair<V> getVertices( E e );
Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java?rev=1142415&r1=1142414&r2=1142415&view=diff
==============================================================================
 commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java (original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/MutableGraph.java Sun
Jul 3 11:08:29 2011
@@ 32,6 +32,9 @@ public interface MutableGraph<V extends
/**
* Adds a feature to the {@link Vertex} attribute of the {@code MutableGraph} object.
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param v the {@link Vertex} has to be added in this {@code MutableGraph} instance.
*/
void addVertex( V v );
@@ 39,6 +42,9 @@ public interface MutableGraph<V extends
/**
* Removes the {@link Vertex} from the {@code MutableGraph} object.
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param v the {@link Vertex} has to be removed from this {@code MutableGraph} instance.
*/
void removeVertex( V v );
@@ 46,6 +52,9 @@ public interface MutableGraph<V extends
/**
* Adds a feature to the {@link Edge} attribute of the {@code MutableGraph} object
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param e the {@link Edge} has to be added in this {@code MutableGraph} instance.
*/
void addEdge( V head, E e, V tail );
@@ 53,6 +62,9 @@ public interface MutableGraph<V extends
/**
* Removed the {@link Edge} from the {@code MutableGraph} object.
*
+ * <b>NOTE</b>: implementors have to take in consideration throwing a {@link
GraphException}
+ * if an error occurs while performing that operation.
+ *
* @param e the {@link Edge} has to be removed from this {@code MutableGraph} instance.
*/
void removeEdge( E e );
