Author: bayard
Date: Wed Feb 2 06:39:50 2011
New Revision: 1066350
URL: http://svn.apache.org/viewvc?rev=1066350&view=rev
Log:
Adding javadoc
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java?rev=1066350&r1=1066349&r2=1066350&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityEscaper.java
Wed Feb 2 06:39:50 2011
@@ -32,28 +32,63 @@ public class NumericEntityEscaper extend
private final int above;
private final boolean between;
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> for the specified
range. This is
+ * the underlying method for the other constructors/builders. The
<code>below</code>
+ * and <code>above</code> boundaries are inclusive when
<code>between</code> is
+ * <code>true</code> and exclusive when it is <code>false</code>. </p>
+ *
+ * @param below int value representing the lowest codepoint boundary
+ * @param above int value representing the highest codepoint boundary
+ * @param between whether to escape between the boundaries or outside them
+ */
private NumericEntityEscaper(int below, int above, boolean between) {
this.below = below;
this.above = above;
this.between = between;
}
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> for all characters.
</p>
+ */
public NumericEntityEscaper() {
this(0, Integer.MAX_VALUE, true);
}
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> below the specified
value (exclusive). </p>
+ *
+ * @param codepoint below which to escape
+ */
public static NumericEntityEscaper below(int codepoint) {
return outsideOf(codepoint, Integer.MAX_VALUE);
}
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> above the specified
value (exclusive). </p>
+ *
+ * @param codepoint above which to escape
+ */
public static NumericEntityEscaper above(int codepoint) {
return outsideOf(0, codepoint);
}
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> between the specified
values (inclusive). </p>
+ *
+ * @param codepointLow above which to escape
+ * @param codepointHigh below which to escape
+ */
public static NumericEntityEscaper between(int codepointLow, int
codepointHigh) {
return new NumericEntityEscaper(codepointLow, codepointHigh, true);
}
+ /**
+ * <p>Constructs a <code>NumericEntityEscaper</code> outside of the
specified values (exclusive). </p>
+ *
+ * @param codepointLow below which to escape
+ * @param codepointHigh above which to escape
+ */
public static NumericEntityEscaper outsideOf(int codepointLow, int
codepointHigh) {
return new NumericEntityEscaper(codepointLow, codepointHigh, false);
}
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java?rev=1066350&r1=1066349&r2=1066350&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java
Wed Feb 2 06:39:50 2011
@@ -32,29 +32,64 @@ public class UnicodeEscaper extends Code
private final int above;
private final boolean between;
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> for all characters. </p>
+ */
public UnicodeEscaper(){
this(0, Integer.MAX_VALUE, true);
}
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> for the specified range.
This is
+ * the underlying method for the other constructors/builders. The
<code>below</code>
+ * and <code>above</code> boundaries are inclusive when
<code>between</code> is
+ * <code>true</code> and exclusive when it is <code>false</code>. </p>
+ *
+ * @param below int value representing the lowest codepoint boundary
+ * @param above int value representing the highest codepoint boundary
+ * @param between whether to escape between the boundaries or outside them
+ */
private UnicodeEscaper(int below, int above, boolean between) {
this.below = below;
this.above = above;
this.between = between;
}
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> below the specified value
(exclusive). </p>
+ *
+ * @param codepoint below which to escape
+ */
public static UnicodeEscaper below(int codepoint) {
return outsideOf(codepoint, Integer.MAX_VALUE);
}
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> above the specified value
(exclusive). </p>
+ *
+ * @param codepoint above which to escape
+ */
public static UnicodeEscaper above(int codepoint) {
return outsideOf(0, codepoint);
}
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> outside of the specified
values (exclusive). </p>
+ *
+ * @param codepointLow below which to escape
+ * @param codepointHigh above which to escape
+ */
public static UnicodeEscaper outsideOf(int codepointLow, int
codepointHigh) {
UnicodeEscaper escaper = new UnicodeEscaper(codepointLow,
codepointHigh, false);
return escaper;
}
+ /**
+ * <p>Constructs a <code>UnicodeEscaper</code> between the specified
values (inclusive). </p>
+ *
+ * @param codepointLow above which to escape
+ * @param codepointHigh below which to escape
+ */
public static UnicodeEscaper between(int codepointLow, int codepointHigh) {
UnicodeEscaper escaper = new UnicodeEscaper(codepointLow,
codepointHigh, true);
return escaper;
