peterreilly 2005/01/24 07:15:39
Modified: src/main/org/apache/tools/ant/util RegexpPatternMapper.java
Log:
javadoc
Revision Changes Path
1.16 +14 -1
ant/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java
Index: RegexpPatternMapper.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/util/RegexpPatternMapper.java,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- RegexpPatternMapper.java 17 Dec 2004 13:06:35 -0000 1.15
+++ RegexpPatternMapper.java 24 Jan 2005 15:15:39 -0000 1.16
@@ -1,5 +1,5 @@
/*
- * Copyright 2000,2002-2004 The Apache Software Foundation
+ * Copyright 2000,2002-2005 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -32,6 +32,10 @@
protected char[] to = null;
protected StringBuffer result = new StringBuffer();
+ /**
+ * Constructor for RegexpPatternMapper.
+ * @throws BuildException on error.
+ */
public RegexpPatternMapper() throws BuildException {
reg = (new RegexpMatcherFactory()).newRegexpMatcher();
}
@@ -66,6 +70,8 @@
/**
* Sets the "from" pattern. Required.
+ * @param from the from pattern.
+ * @throws BuildException on error.
*/
public void setFrom(String from) throws BuildException {
try {
@@ -80,6 +86,8 @@
/**
* Sets the "to" pattern. Required.
+ * @param to the to pattern.
+ * @throws BuildException on error.
*/
public void setTo(String to) {
this.to = to.toCharArray();
@@ -89,6 +97,9 @@
* Returns null if the source file name doesn't match the
* "from" pattern, an one-element array containing the
* translated file otherwise.
+ * @param sourceFileName the source file name
+ * @return a one-element array containing the translated file or
+ * null if the to pattern did not match
*/
public String[] mapFileName(String sourceFileName) {
if (handleDirChar) {
@@ -106,6 +117,8 @@
/**
* Replace all backreferences in the to pattern with the matched
* groups of the source.
+ * @param source the source file name.
+ * @return the translated file name.
*/
protected String replaceReferences(String source) {
Vector v = reg.getGroups(source, regexpOptions);
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
