You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by ju...@apache.org on 2002/02/27 17:49:50 UTC
cvs commit: jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs Archive.java ArchiveParser.java ArchiveParser.jj BranchNode.java HeadAlreadySetException.java InvalidBranchVersionNumberException.java InvalidFileFormatException.java InvalidTrunkVersionNumberException.java InvalidVersionNumberException.java Line.java Lines.java Node.java Path.java Phrases.java TrunkNode.java Version.java
juanco 02/02/27 08:49:50
Modified: src/java/org/apache/maven/jrcs/rcs Archive.java
ArchiveParser.java ArchiveParser.jj BranchNode.java
HeadAlreadySetException.java
InvalidBranchVersionNumberException.java
InvalidFileFormatException.java
InvalidTrunkVersionNumberException.java
InvalidVersionNumberException.java Line.java
Lines.java Node.java Path.java Phrases.java
TrunkNode.java Version.java
Log:
Improved adherance to Turbine coding guidelines
Revision Changes Path
1.14 +2 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Archive.java
Index: Archive.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Archive.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- Archive.java 27 Feb 2002 07:44:26 -0000 1.13
+++ Archive.java 27 Feb 2002 16:49:48 -0000 1.14
@@ -80,7 +80,9 @@
/**
* Handling of RCS/CVS version control archives.
* This class is NOT thread safe.
+ *
* @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Archive.java,v 1.14 2002/02/27 16:49:48 juanco Exp $
*/
public class Archive
extends ToString
1.6 +8 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/ArchiveParser.java
Index: ArchiveParser.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/ArchiveParser.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ArchiveParser.java 26 Feb 2002 22:43:15 -0000 1.5
+++ ArchiveParser.java 27 Feb 2002 16:49:48 -0000 1.6
@@ -60,6 +60,14 @@
import java.io.FileNotFoundException;
import java.io.InputStream;
+/**
+ * Parses an RCS/CVS style version control archive into an Archive.
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: ArchiveParser.java,v 1.6 2002/02/27 16:49:48 juanco Exp $
+ * @see Archive
+ */
class ArchiveParser implements ArchiveParserConstants
{
1.5 +8 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/ArchiveParser.jj
Index: ArchiveParser.jj
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/ArchiveParser.jj,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ArchiveParser.jj 23 Feb 2002 13:45:39 -0000 1.4
+++ ArchiveParser.jj 27 Feb 2002 16:49:48 -0000 1.5
@@ -85,6 +85,14 @@
import java.io.FileNotFoundException;
import java.io.InputStream;
+/**
+ * Parses an RCS/CVS style version control archive into an Archive.
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: ArchiveParser.jj,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ * @see Archive
+ */
class ArchiveParser {
static final String ident = "RCS ArchiveParser Parser $version$:";
1.5 +12 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/BranchNode.java
Index: BranchNode.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/BranchNode.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- BranchNode.java 23 Feb 2002 13:52:59 -0000 1.4
+++ BranchNode.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,7 +55,18 @@
*/
-class BranchNode extends Node
+/**
+ * Represents a branch node in a version control archive.
+ * This class is NOT thread safe.
+ *
+ * @see Node
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: BranchNode.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
+class BranchNode
+ extends Node
{
/**
* the next field in a Branch node points to the next higher
1.5 +12 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/HeadAlreadySetException.java
Index: HeadAlreadySetException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/HeadAlreadySetException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- HeadAlreadySetException.java 23 Feb 2002 13:52:59 -0000 1.4
+++ HeadAlreadySetException.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,7 +55,18 @@
*/
-public class HeadAlreadySetException extends IllegalArgumentException
+/**
+ * Thrown if the ArchiveParser finds that the head node is set more than once.
+ * This class is NOT thread safe.
+ *
+ * @see Archive
+ * @see ArchiveParser
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: HeadAlreadySetException.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
+public class HeadAlreadySetException
+ extends IllegalArgumentException
{
public HeadAlreadySetException()
{
1.5 +12 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidBranchVersionNumberException.java
Index: InvalidBranchVersionNumberException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidBranchVersionNumberException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- InvalidBranchVersionNumberException.java 23 Feb 2002 13:52:59 -0000 1.4
+++ InvalidBranchVersionNumberException.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,7 +55,18 @@
*/
-public class InvalidBranchVersionNumberException extends InvalidVersionNumberException
+/**
+ * Thrown if the version number given for a branch node is invalid.
+ * Branch version numbers must be of the form (x.y)+, tha is, they
+ * must have an even number of version digits, and an odd number of
+ * dots.
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: InvalidBranchVersionNumberException.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
+public class InvalidBranchVersionNumberException
+ extends InvalidVersionNumberException
{
public InvalidBranchVersionNumberException()
1.5 +9 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidFileFormatException.java
Index: InvalidFileFormatException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidFileFormatException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- InvalidFileFormatException.java 23 Feb 2002 13:52:59 -0000 1.4
+++ InvalidFileFormatException.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,7 +55,15 @@
*/
-public class InvalidFileFormatException extends RCSException
+/**
+ * Thrown if the ArchiveParser cannot parse a given archive.
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: InvalidFileFormatException.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
+public class InvalidFileFormatException
+ extends RCSException
{
public InvalidFileFormatException()
1.5 +8 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidTrunkVersionNumberException.java
Index: InvalidTrunkVersionNumberException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidTrunkVersionNumberException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- InvalidTrunkVersionNumberException.java 23 Feb 2002 13:52:59 -0000 1.4
+++ InvalidTrunkVersionNumberException.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,6 +55,14 @@
*/
+/**
+ * Thrown if the version number given for a trunk node is invalid.
+ * Version numbers for trunk nodes must be of the form x.y .
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: InvalidTrunkVersionNumberException.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
public class InvalidTrunkVersionNumberException
extends InvalidVersionNumberException
{
1.5 +9 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidVersionNumberException.java
Index: InvalidVersionNumberException.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/InvalidVersionNumberException.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- InvalidVersionNumberException.java 23 Feb 2002 13:52:59 -0000 1.4
+++ InvalidVersionNumberException.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -54,8 +54,16 @@
* <http://www.apache.org/>.
*/
+/**
+ * Thrown whenever a given version number is invalid for the context.
+ * This class is NOT thread safe.
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: InvalidVersionNumberException.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
-public class InvalidVersionNumberException extends IllegalArgumentException
+public class InvalidVersionNumberException
+ extends IllegalArgumentException
{
public InvalidVersionNumberException()
{
1.5 +12 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Line.java
Index: Line.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Line.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Line.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Line.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -55,6 +55,18 @@
*/
+/**
+ * An annotated line of a revision.
+ * Line contains both the original text of the line, plus the node
+ * that indicates the revision in which the line was last added or changed.
+ * This class is NOT thread safe.
+ *
+ * @see Node
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Line.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
class Line
{
public Node revision;
1.5 +15 -2 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Lines.java
Index: Lines.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Lines.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Lines.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Lines.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -60,7 +60,20 @@
import java.util.ArrayList;
import java.util.Iterator;
-class Lines extends ArrayList
+import org.apache.maven.jrcs.diff.Diff;
+
+/**
+ * A list of the lines in the text of a revision annotated with the
+ * version that corresponds to each line.
+ *
+ * @see Line
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Lines.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
+class Lines
+ extends ArrayList
{
public static final Format annotationFormat = new MessageFormat(
@@ -78,7 +91,7 @@
public Lines(Node release, String text)
{
- this(release, org.apache.maven.jrcs.diff.Diff.stringToArray(text));
+ this(release, Diff.stringToArray(text));
}
public Lines(Object[] text)
1.5 +11 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Node.java
Index: Node.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Node.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Node.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Node.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -76,6 +76,17 @@
import org.apache.maven.jrcs.diff.Revision;
import org.apache.maven.jrcs.util.ToString;
+/**
+ * Ancestor to all nodes in a version control Archive.
+ * This class is NOT thread safe.
+ *
+ * @see TrunkNode
+ * @see BranchNode
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Node.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
abstract class Node
extends ToString
implements Comparable
1.5 +13 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Path.java
Index: Path.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Path.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Path.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Path.java 27 Feb 2002 16:49:48 -0000 1.5
@@ -61,6 +61,19 @@
import org.apache.maven.jrcs.diff.PatchFailedException;
+/**
+ * A path from the head revision to a given revision in an Archive.
+ * Path collaborates with Node in applying the set of deltas contained
+ * in archive nodes to arrive at the text of the revision corresponding
+ * to the last node in the path.
+ * This class is NOT thread safe.
+ *
+ * @see Archive
+ * @see Node
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Path.java,v 1.5 2002/02/27 16:49:48 juanco Exp $
+ */
class Path
{
protected List _path = new LinkedList();
1.5 +13 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Phrases.java
Index: Phrases.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Phrases.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Phrases.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Phrases.java 27 Feb 2002 16:49:49 -0000 1.5
@@ -58,7 +58,19 @@
import java.util.Iterator;
import java.util.TreeMap;
-class Phrases extends TreeMap
+/**
+ * A set of "new phrases" for an Archive.
+ * Phrases are keyed lists of symbols. An Archive stores the keys
+ * it doesn't recognizes in a Phrases set to preserve them. Unrecognized
+ * keys probably belong to archive extensions.
+ *
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Phrases.java,v 1.5 2002/02/27 16:49:49 juanco Exp $
+ */
+class Phrases
+ extends TreeMap
{
public void toString(StringBuffer s, String EOL)
{
1.5 +12 -1 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/TrunkNode.java
Index: TrunkNode.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/TrunkNode.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TrunkNode.java 23 Feb 2002 13:52:59 -0000 1.4
+++ TrunkNode.java 27 Feb 2002 16:49:49 -0000 1.5
@@ -57,7 +57,18 @@
import java.util.List;
-class TrunkNode extends Node
+/**
+ * Represents a node on the trunk or main branch of a version control Archive.
+ * This class is NOT thread safe.
+ *
+ * @see Node
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: TrunkNode.java,v 1.5 2002/02/27 16:49:49 juanco Exp $
+ */
+class TrunkNode
+ extends Node
{
TrunkNode(TrunkNode other)
1.5 +9 -0 jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Version.java
Index: Version.java
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/jrcs/rcs/Version.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Version.java 23 Feb 2002 13:52:59 -0000 1.4
+++ Version.java 27 Feb 2002 16:49:49 -0000 1.5
@@ -60,6 +60,15 @@
import org.apache.maven.jrcs.util.ToString;
+/**
+ * Contains and manages a version number of the form x.y.z... .
+ * This class is NOT thread safe.
+ *
+ * @see Archive
+ *
+ * @author <a href="mailto:juanco@suigeneris.org">Juanco Anez</a>
+ * @version $Id: Version.java,v 1.5 2002/02/27 16:49:49 juanco Exp $
+ */
public class Version
extends ToString
implements Cloneable, Comparable
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>