From commits-return-20213-apmail-commons-commits-archive=commons.apache.org@commons.apache.org Sun Jul 3 11:08:59 2011 Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CD6FB4931 for ; Sun, 3 Jul 2011 11:08:59 +0000 (UTC) Received: (qmail 64658 invoked by uid 500); 3 Jul 2011 11:08:59 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 64311 invoked by uid 500); 3 Jul 2011 11:08:54 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 64295 invoked by uid 99); 3 Jul 2011 11:08:53 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 03 Jul 2011 11:08:53 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 03 Jul 2011 11:08:50 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 886E82388980 for ; Sun, 3 Jul 2011 11:08:29 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1142415 - in /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph: Graph.java MutableGraph.java Date: Sun, 03 Jul 2011 11:08:29 -0000 To: commits@commons.apache.org From: simonetripodi@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110703110829.886E82388980@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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 GraphNOTE: 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 getVertices(); @@ -40,13 +43,19 @@ public interface Graphorder of a Graph (the number of Vertices); * + * NOTE: implementors have to take in consideration throwing a {@link GraphException} + * if an error occurs while performing that operation. + * * @return the order of a Graph (the number of Vertices); */ int getOrder(); /** * Returns the total set of Edges in the graph. - * + * + * NOTE: 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 getEdges(); @@ -54,6 +63,9 @@ public interface Graphsize of a Graph (the number of Edges) * + * NOTE: implementors have to take in consideration throwing a {@link GraphException} + * if an error occurs while performing that operation. + * * @return the size of a Graph (the number of Edges) */ int getSize(); @@ -62,6 +74,9 @@ public interface GraphNOTE: 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 GraphNOTE: 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 getConnectedVertices( V v ); /** * Returns the edge with vertex source and target. - * + * + * NOTE: 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 2 for HyperEdges) - * + * + * NOTE: 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 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 MutableGraphNOTE: 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 MutableGraphNOTE: 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 MutableGraphNOTE: 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 MutableGraphNOTE: 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 );