You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ni...@apache.org on 2006/07/10 13:23:58 UTC
svn commit: r420491 - in
/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang:
StringEscapeUtils.java enum/Enum.java enums/Enum.java text/StrBuilder.java
text/VariableFormatter.java time/DurationFormatUtils.java
Author: niallp
Date: Mon Jul 10 04:23:57 2006
New Revision: 420491
URL: http://svn.apache.org/viewvc?rev=420491&view=rev
Log:
Fix for LANG-272 - Minor JavaDoc changes to clean up checkstyle issues
Modified:
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enum/Enum.java
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enums/Enum.java
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/StrBuilder.java
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/VariableFormatter.java
jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DurationFormatUtils.java
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/StringEscapeUtils.java Mon Jul 10 04:23:57 2006
@@ -571,7 +571,6 @@
*
* @param writer the writer receiving the unescaped string, not null
* @param str the <code>String</code> to escape, may be null
- * @return a new escaped <code>String</code>, <code>null</code> if null string input
* @throws IllegalArgumentException if the writer is null
* @throws IOException if there is a problem writing
* @see #unescapeXml(java.lang.String)
@@ -624,7 +623,6 @@
*
* @param writer the writer receiving the unescaped string, not null
* @param str the <code>String</code> to unescape, may be null
- * @return a new unescaped <code>String</code>, <code>null</code> if null string input
* @throws IllegalArgumentException if the writer is null
* @throws IOException if there is a problem writing
* @see #escapeXml(String)
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enum/Enum.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enum/Enum.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enum/Enum.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enum/Enum.java Mon Jul 10 04:23:57 2006
@@ -587,6 +587,12 @@
return iName.compareTo(((Enum) other).iName);
}
+ /**
+ * <p>Use reflection to return an objects class name.</p>
+ *
+ * @param other The object to determine the class name for
+ * @return The class name
+ */
private String getNameInOtherClassLoader(Object other) {
try {
Method mth = other.getClass().getMethod("getName", null);
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enums/Enum.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enums/Enum.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enums/Enum.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/enums/Enum.java Mon Jul 10 04:23:57 2006
@@ -584,6 +584,12 @@
return iName.compareTo(((Enum) other).iName);
}
+ /**
+ * <p>Use reflection to return an objects class name.</p>
+ *
+ * @param other The object to determine the class name for
+ * @return The class name
+ */
private String getNameInOtherClassLoader(Object other) {
try {
Method mth = other.getClass().getMethod("getName", null);
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/StrBuilder.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/StrBuilder.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/StrBuilder.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/StrBuilder.java Mon Jul 10 04:23:57 2006
@@ -2187,16 +2187,17 @@
/** The last mark position. */
private int mark;
+ /** {@inheritDoc} */
StrBuilderReader() {
super();
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void close() {
// do nothing
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public int read() {
if (ready() == false) {
return -1;
@@ -2204,7 +2205,7 @@
return charAt(pos++);
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public int read(char b[], int off, int len) {
if (off < 0 || len < 0 || off > b.length ||
(off + len) > b.length || (off + len) < 0) {
@@ -2224,6 +2225,7 @@
return len;
}
+ /** {@inheritDoc} */
public long skip(long n) {
if (pos + n > size()) {
n = size() - pos;
@@ -2235,22 +2237,22 @@
return n;
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public boolean ready() {
return pos < size();
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public boolean markSupported() {
return true;
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void mark(int readAheadLimit) {
mark = pos;
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void reset() {
pos = mark;
}
@@ -2261,41 +2263,43 @@
* Inner class to allow StrBuilder to operate as a writer.
*/
class StrBuilderWriter extends Writer {
+
+ /** {@inheritDoc} */
StrBuilderWriter() {
super();
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void close() {
// do nothing
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void flush() {
// do nothing
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void write(int c) {
StrBuilder.this.append((char) c);
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void write(char[] cbuf) {
StrBuilder.this.append(cbuf);
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void write(char[] cbuf, int off, int len) {
StrBuilder.this.append(cbuf, off, len);
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void write(String str) {
StrBuilder.this.append(str);
}
- /** @inheritdoc */
+ /** {@inheritDoc} */
public void write(String str, int off, int len) {
StrBuilder.this.append(str, off, len);
}
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/VariableFormatter.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/VariableFormatter.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/VariableFormatter.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/text/VariableFormatter.java Mon Jul 10 04:23:57 2006
@@ -205,6 +205,17 @@
return newToken(VariableParser.TEXT_TOKEN, aStartIndex, aLength);
}
+ /**
+ * Creates a new token of the specified type.
+ *
+ * @param type
+ * The token type
+ * @param beginIndex
+ * The token starting index
+ * @param length
+ * The token length
+ * @return a new token
+ */
private static FieldPosition newToken(int type, int beginIndex, int length) {
FieldPosition fp = new FieldPosition(type);
fp.setBeginIndex(beginIndex);
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DurationFormatUtils.java
URL: http://svn.apache.org/viewvc/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DurationFormatUtils.java?rev=420491&r1=420490&r2=420491&view=diff
==============================================================================
--- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DurationFormatUtils.java (original)
+++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/time/DurationFormatUtils.java Mon Jul 10 04:23:57 2006
@@ -622,6 +622,8 @@
* Returns a hashcode for the token equal to the
* hashcode for the token's value. Thus 'TT' and 'TTTT'
* will have the same hashcode.
+ *
+ * @return The hashcode for the token
*/
public int hashCode() {
return this.value.hashCode();
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org