Author: marcosperanza
Date: Thu Jul 12 13:31:16 2012
New Revision: 1360667
URL: http://svn.apache.org/viewvc?rev=1360667&view=rev
Log:
Filled some javadocs, no functional modifications
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Mapper.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Mapper.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Mapper.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Mapper.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/Mapper.java
Thu Jul 12 13:31:16 2012
@@ -21,10 +21,21 @@ package org.apache.commons.graph;
import java.io.Serializable;
+/**
+ * TODO Fill the java doc
+ *
+ * @param <I> the input type
+ * @param <O> the output type
+ */
public interface Mapper<I, O>
extends Serializable
{
+ /**
+ * TODO Fill the java doc
+ * @param input
+ * @return
+ */
O map( I input );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/AbstractGraphConnection.java
Thu Jul 12 13:31:16 2012
@@ -21,12 +21,21 @@ package org.apache.commons.graph.builder
import static org.apache.commons.graph.utils.Assertions.checkState;
+/**
+ * TODO fill me!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ */
public abstract class AbstractGraphConnection<V, E>
implements GraphConnection<V, E>
{
private GraphConnector<V, E> connector;
+ /**
+ * {@inheritDoc}
+ */
public final void connect( GraphConnector<V, E> connector )
{
checkState( this.connector == null, "Re-entry not allowed!" );
@@ -42,16 +51,31 @@ public abstract class AbstractGraphConne
}
}
+ /**
+ * Adds a new vertex to graph connector.
+ *
+ * @param node the vertex to add
+ * @return the vertex added
+ */
protected final <N extends V> N addVertex( N node )
{
return connector.addVertex( node );
}
+ /**
+ * Adds a new edge to graph connector.
+ *
+ * @param arc the edge to add.
+ * @return the {@link HeadVertexConnector}
+ */
protected final <A extends E> HeadVertexConnector<V, E> addEdge( A arc )
{
return connector.addEdge( arc );
}
+ /**
+ * Connets the graph
+ */
public abstract void connect();
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/DefaultLinkedConnectionBuilder.java
Thu Jul 12 13:31:16 2012
@@ -23,17 +23,32 @@ import static org.apache.commons.graph.u
import org.apache.commons.graph.MutableGraph;
+/**
+ * TODO Fillme!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ * @param <G> the Graph type
+ */
public final class DefaultLinkedConnectionBuilder<V, E, G extends
MutableGraph<V, E>>
implements LinkedConnectionBuilder<V, E, G>
{
private final G graph;
+ /**
+ * Creates a new {@link DefaultLinkedConnectionBuilder} for the graph.
+ *
+ * @param graph the graph
+ */
public DefaultLinkedConnectionBuilder( G graph )
{
this.graph = graph;
}
+ /**
+ * {@inheritDoc}
+ */
public G withConnections( GraphConnection<V, E> graphConnection )
{
graphConnection = checkNotNull( graphConnection, "Input graph cannot
be configured with null connections" );
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnection.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnection.java
Thu Jul 12 13:31:16 2012
@@ -19,10 +19,19 @@ package org.apache.commons.graph.builder
* under the License.
*/
-
+/**
+ * TODO Fillme!!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ */
public interface GraphConnection<V, E>
{
+ /**
+ * TODO Fillme!!
+ * @param grapher
+ */
void connect( GraphConnector<V, E> grapher );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/GraphConnector.java
Thu Jul 12 13:31:16 2012
@@ -19,12 +19,29 @@ package org.apache.commons.graph.builder
* under the License.
*/
-
+/**
+ * TODO Fillme!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ */
public interface GraphConnector<V, E>
{
+ /**
+ * Adds a new vertex to graph.
+ *
+ * @param node the vertex to add
+ * @return the vertex added
+ */
<N extends V> N addVertex( N node );
+ /**
+ * Adds a new edge to graph.
+ *
+ * @param arc the edge to add.
+ * @return the {@link HeadVertexConnector}
+ */
<A extends E> HeadVertexConnector<V, E> addEdge( A arc );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/HeadVertexConnector.java
Thu Jul 12 13:31:16 2012
@@ -20,9 +20,21 @@ package org.apache.commons.graph.builder
*/
+/**
+ * TODO Fillme!!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ */
public interface HeadVertexConnector<V, E>
{
+ /**
+ * Specifies the head vertex for the edge
+ *
+ * @param head the head vertex
+ * @return {@link TailVertexConnector} builded from the head
+ */
<H extends V> TailVertexConnector<V, E> from( H head );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/LinkedConnectionBuilder.java
Thu Jul 12 13:31:16 2012
@@ -21,9 +21,22 @@ package org.apache.commons.graph.builder
import org.apache.commons.graph.MutableGraph;
+/**
+ * TODO Fillme!!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ * @param <G> the Graph type
+ */
public interface LinkedConnectionBuilder<V, E, G extends MutableGraph<V, E>>
{
+ /**
+ * Connects the graph.
+ *
+ * @param graphConnection the {@link GraphConnection}
+ * @return the {@link org.apache.commons.graph.Graph} built from the
connections.
+ */
G withConnections( GraphConnection<V, E> graphConnection );
}
Modified:
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java?rev=1360667&r1=1360666&r2=1360667&view=diff
==============================================================================
---
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
(original)
+++
commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/builder/TailVertexConnector.java
Thu Jul 12 13:31:16 2012
@@ -19,10 +19,19 @@ package org.apache.commons.graph.builder
* under the License.
*/
-
+/**
+ * TODO Fillme!!!
+ *
+ * @param <V> the Graph vertices type
+ * @param <E> the Graph edges type
+ */
public interface TailVertexConnector<V, E>
{
-
+
+ /**
+ * Specifies the tail vertex for the edge
+ * @param tail the tail vertex
+ */
<T extends V> void to( T tail );
}
