http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java index 8db6ca4..3f568d1 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java +++ b/src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java @@ -56,7 +56,7 @@ public class TypeUtils { */ private WildcardTypeBuilder() { } - + private Type[] upperBounds; private Type[] lowerBounds; @@ -91,7 +91,7 @@ public class TypeUtils { /** * GenericArrayType implementation class. - * @since 3.2 + * @since 3.2 */ private static final class GenericArrayTypeImpl implements GenericArrayType { private final Type componentType; @@ -141,7 +141,7 @@ public class TypeUtils { /** * ParameterizedType implementation class. - * @since 3.2 + * @since 3.2 */ private static final class ParameterizedTypeImpl implements ParameterizedType { private final Class<?> raw; @@ -217,7 +217,7 @@ public class TypeUtils { /** * WildcardType implementation class. - * @since 3.2 + * @since 3.2 */ private static final class WildcardTypeImpl implements WildcardType { private static final Type[] EMPTY_BOUNDS = new Type[0]; @@ -1400,7 +1400,7 @@ public class TypeUtils { /** * Local helper method to unroll variables in a type bounds array. - * + * * @param typeArguments assignments {@link Map} * @param bounds in which to expand variables * @return {@code bounds} with any variables reassigned
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/reflect/Typed.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/reflect/Typed.java b/src/main/java/org/apache/commons/lang3/reflect/Typed.java index 4841f5c..b21b51b 100644 --- a/src/main/java/org/apache/commons/lang3/reflect/Typed.java +++ b/src/main/java/org/apache/commons/lang3/reflect/Typed.java @@ -27,7 +27,7 @@ public interface Typed<T> { /** * Get the {@link Type} represented by this entity. - * + * * @return Type */ Type getType(); http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java index bac62ec..f365969 100644 --- a/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java +++ b/src/main/java/org/apache/commons/lang3/text/CompositeFormat.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -34,7 +34,7 @@ public class CompositeFormat extends Format { /** * Required for serialization support. - * + * * @see java.io.Serializable */ private static final long serialVersionUID = -4329119827877627683L; @@ -47,7 +47,7 @@ public class CompositeFormat extends Format { /** * Create a format that points its parseObject method to one implementation * and its format method to another. - * + * * @param parser implementation * @param formatter implementation */ @@ -58,7 +58,7 @@ public class CompositeFormat extends Format { /** * Uses the formatter Format instance. - * + * * @param obj the object to format * @param toAppendTo the {@link StringBuffer} to append to * @param pos the FieldPosition to use (or ignore). @@ -73,7 +73,7 @@ public class CompositeFormat extends Format { /** * Uses the parser Format instance. - * + * * @param source the String source * @param pos the ParsePosition containing the position to parse from, will * be updated according to parsing success (index) or failure @@ -88,7 +88,7 @@ public class CompositeFormat extends Format { /** * Provides access to the parser Format implementation. - * + * * @return parser Format implementation */ public Format getParser() { @@ -97,7 +97,7 @@ public class CompositeFormat extends Format { /** * Provides access to the parser Format implementation. - * + * * @return formatter Format implementation */ public Format getFormatter() { @@ -106,7 +106,7 @@ public class CompositeFormat extends Format { /** * Utility method to parse and then reformat a String. - * + * * @param input String to reformat * @return A reformatted String * @throws ParseException thrown by parseObject(String) call http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java index 75e53a0..6c9948b 100644 --- a/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java +++ b/src/main/java/org/apache/commons/lang3/text/ExtendedMessageFormat.java @@ -477,7 +477,7 @@ public class ExtendedMessageFormat extends MessageFormat { */ private StringBuilder appendQuotedString(final String pattern, final ParsePosition pos, final StringBuilder appendTo) { - assert pattern.toCharArray()[pos.getIndex()] == QUOTE : + assert pattern.toCharArray()[pos.getIndex()] == QUOTE : "Quoted string must start with quote character"; // handle quote character at the beginning of the string http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/FormatFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java index b6e3583..0a206d0 100644 --- a/src/main/java/org/apache/commons/lang3/text/FormatFactory.java +++ b/src/main/java/org/apache/commons/lang3/text/FormatFactory.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -21,7 +21,7 @@ import java.util.Locale; /** * Format factory. - * + * * @since 2.4 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormatFactory.html";> http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java index 9fdf6ec..87cd84c 100644 --- a/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java +++ b/src/main/java/org/apache/commons/lang3/text/FormattableUtils.java @@ -27,11 +27,11 @@ import org.apache.commons.lang3.Validate; /** * <p>Provides utilities for working with the {@code Formattable} interface.</p> - * + * * <p>The {@link Formattable} interface provides basic control over formatting * when using a {@code Formatter}. It is primarily concerned with numeric precision * and padding, and is not designed to allow generalised alternate formats.</p> - * + * * @since Lang 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/FormattableUtils.html";> @@ -49,7 +49,7 @@ public class FormattableUtils { * <p>{@code FormattableUtils} instances should NOT be constructed in * standard programming. Instead, the methods of the class should be invoked * statically.</p> - * + * * <p>This constructor is public to permit tools that require a JavaBean * instance to operate.</p> */ @@ -61,7 +61,7 @@ public class FormattableUtils { /** * Get the default formatted representation of the specified * {@code Formattable}. - * + * * @param formattable the instance to convert to a string, not null * @return the resulting string, not null */ @@ -73,7 +73,7 @@ public class FormattableUtils { * Handles the common {@code Formattable} operations of truncate-pad-append, * with no ellipsis on precision overflow, and padding width underflow with * spaces. - * + * * @param seq the string to handle, not null * @param formatter the destination formatter, not null * @param flags the flags for formatting, see {@code Formattable} @@ -89,7 +89,7 @@ public class FormattableUtils { /** * Handles the common {@link Formattable} operations of truncate-pad-append, * with no ellipsis on precision overflow. - * + * * @param seq the string to handle, not null * @param formatter the destination formatter, not null * @param flags the flags for formatting, see {@code Formattable} @@ -106,7 +106,7 @@ public class FormattableUtils { /** * Handles the common {@link Formattable} operations of truncate-pad-append, * padding width underflow with spaces. - * + * * @param seq the string to handle, not null * @param formatter the destination formatter, not null * @param flags the flags for formatting, see {@code Formattable} @@ -123,7 +123,7 @@ public class FormattableUtils { /** * Handles the common {@link Formattable} operations of truncate-pad-append. - * + * * @param seq the string to handle, not null * @param formatter the destination formatter, not null * @param flags the flags for formatting, see {@code Formattable} http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/StrBuilder.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java index cb0bf9d..4e69cd5 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrBuilder.java +++ b/src/main/java/org/apache/commons/lang3/text/StrBuilder.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -67,9 +67,9 @@ import org.apache.commons.lang3.builder.Builder; * The biggest of these changes is that by default, null will not output the text * 'null'. This can be controlled by a property, {@link #setNullText(String)}. * <p> - * Prior to 3.0, this class implemented Cloneable but did not implement the - * clone method so could not be used. From 3.0 onwards it no longer implements - * the interface. + * Prior to 3.0, this class implemented Cloneable but did not implement the + * clone method so could not be used. From 3.0 onwards it no longer implements + * the interface. * * @since 2.2 * @deprecated as of 3.6, use commons-text @@ -86,7 +86,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Required for serialization support. - * + * * @see java.io.Serializable */ private static final long serialVersionUID = 7628716375283629643L; @@ -355,7 +355,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Copies the builder's character array into a new character array. - * + * * @return a new array that represents the contents of the builder */ public char[] toCharArray() { @@ -369,7 +369,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Copies part of the builder's character array into a new character array. - * + * * @param startIndex the start index, inclusive, must be valid * @param endIndex the end index, exclusive, must be valid except that * if too large it is treated as end of string @@ -390,7 +390,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Copies the character array into the specified array. - * + * * @param destination the destination array, null will cause an array to be created * @return the input array, unless that was null or too small */ @@ -512,7 +512,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build if (obj instanceof CharSequence) { return append((CharSequence) obj); } - return append(obj.toString()); + return append(obj.toString()); } /** @@ -540,7 +540,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build if (seq instanceof CharBuffer) { return append((CharBuffer) seq); } - return append(seq.toString()); + return append(seq.toString()); } /** @@ -557,10 +557,10 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build public StrBuilder append(final CharSequence seq, final int startIndex, final int length) { if (seq == null) { return appendNull(); - } + } return append(seq.toString(), startIndex, length); } - + /** * Appends a string to this string builder. * Appending null will call {@link #appendNull()}. @@ -581,7 +581,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build } return this; } - + /** * Appends part of a string to this string builder. @@ -750,7 +750,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build } return this; } - + /** * Appends part of a StringBuilder to this string builder. * Appending null will call {@link #appendNull()}. @@ -1327,7 +1327,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * </pre> * Note that for this simple example, you should use * {@link #appendWithSeparators(Iterable, String)}. - * + * * @param separator the separator to use, null means no separator * @return this, to enable chaining * @since 2.3 @@ -1340,7 +1340,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Appends one of both separators to the StrBuilder. * If the builder is currently empty it will append the defaultIfEmpty-separator * Otherwise it will append the standard-separator - * + * * Appending a null separator will have no effect. * The separator is appended using {@link #append(String)}. * <p> @@ -1357,7 +1357,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * } * selectClause.append(whereClause) * </pre> - * + * * @param standard the separator if builder is not empty, null means no separator * @param defaultIfEmpty the separator if builder is empty, null means no separator * @return this, to enable chaining @@ -1385,7 +1385,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * </pre> * Note that for this simple example, you should use * {@link #appendWithSeparators(Iterable, String)}. - * + * * @param separator the separator to use * @return this, to enable chaining * @since 2.3 @@ -1432,7 +1432,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * </pre> * Note that for this simple example, you should use * {@link #appendWithSeparators(Iterable, String)}. - * + * * @param separator the separator to use, null means no separator * @param loopIndex the loop index * @return this, to enable chaining @@ -1460,7 +1460,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * </pre> * Note that for this simple example, you should use * {@link #appendWithSeparators(Iterable, String)}. - * + * * @param separator the separator to use * @param loopIndex the loop index * @return this, to enable chaining @@ -1476,7 +1476,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Appends the pad character to the builder the specified number of times. - * + * * @param length the length to append, negative means no append * @param padChar the character to append * @return this, to enable chaining @@ -1497,7 +1497,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * The <code>toString</code> of the object is used. * If the object is larger than the length, the left hand side is lost. * If the object is null, the null text value is used. - * + * * @param obj the object to append, null uses null text * @param width the fixed field width, zero or negative has no effect * @param padChar the pad character to use @@ -1529,7 +1529,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Appends an object to the builder padding on the left to a fixed width. * The <code>String.valueOf</code> of the <code>int</code> value is used. * If the formatted value is larger than the length, the left hand side is lost. - * + * * @param value the value to append * @param width the fixed field width, zero or negative has no effect * @param padChar the pad character to use @@ -1544,7 +1544,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * The <code>toString</code> of the object is used. * If the object is larger than the length, the right hand side is lost. * If the object is null, null text value is used. - * + * * @param obj the object to append, null uses null text * @param width the fixed field width, zero or negative has no effect * @param padChar the pad character to use @@ -1576,7 +1576,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Appends an object to the builder padding on the right to a fixed length. * The <code>String.valueOf</code> of the <code>int</code> value is used. * If the object is larger than the length, the right hand side is lost. - * + * * @param value the value to append * @param width the fixed field width, zero or negative has no effect * @param padChar the pad character to use @@ -2134,14 +2134,14 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Reverses the string builder placing each character in the opposite index. - * + * * @return this, to enable chaining */ public StrBuilder reverse() { if (size == 0) { return this; } - + final int half = size / 2; final char[] buf = buffer; for (int leftIdx = 0, rightIdx = size - 1; leftIdx < half; leftIdx++,rightIdx--) { @@ -2186,7 +2186,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Checks whether this builder starts with the specified string. * <p> * Note that this method handles null input quietly, unlike String. - * + * * @param str the string to search for, null returns false * @return true if the builder starts with the string */ @@ -2213,7 +2213,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Checks whether this builder ends with the specified string. * <p> * Note that this method handles null input quietly, unlike String. - * + * * @param str the string to search for, null returns false * @return true if the builder ends with the string */ @@ -2258,7 +2258,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Extracts a portion of this string builder as a string. - * + * * @param start the start index, inclusive, must be valid * @return the new string * @throws IndexOutOfBoundsException if the index is invalid @@ -2273,7 +2273,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Note: This method treats an endIndex greater than the length of the * builder as equal to the length of the builder, and continues * without error, unlike StringBuffer or String. - * + * * @param startIndex the start index, inclusive, must be valid * @param endIndex the end index, exclusive, must be valid except * that if too large it is treated as end of string @@ -2293,7 +2293,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * the builder. If this many characters are not available, the whole * builder is returned. Thus the returned string may be shorter than the * length requested. - * + * * @param length the number of characters to extract, negative returns empty string * @return the new string */ @@ -2315,7 +2315,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * the builder. If this many characters are not available, the whole * builder is returned. Thus the returned string may be shorter than the * length requested. - * + * * @param length the number of characters to extract, negative returns empty string * @return the new string */ @@ -2340,7 +2340,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * If the length is negative, the empty string is returned. * If insufficient characters are available in the builder, as much as possible is returned. * Thus the returned string may be shorter than the length requested. - * + * * @param index the index to start at, negative means zero * @param length the number of characters to extract, negative returns empty string * @return the new string @@ -2403,7 +2403,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Searches the string builder to find the first reference to the specified char. - * + * * @param ch the character to find * @return the first index of the character, or -1 if not found */ @@ -2413,7 +2413,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Searches the string builder to find the first reference to the specified char. - * + * * @param ch the character to find * @param startIndex the index to start at, invalid index rounded to edge * @return the first index of the character, or -1 if not found @@ -2436,7 +2436,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Searches the string builder to find the first reference to the specified string. * <p> * Note that a null input string will return -1, whereas the JDK throws an exception. - * + * * @param str the string to find, null returns -1 * @return the first index of the string, or -1 if not found */ @@ -2449,7 +2449,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * string starting searching from the given index. * <p> * Note that a null input string will return -1, whereas the JDK throws an exception. - * + * * @param str the string to find, null returns -1 * @param startIndex the index to start at, invalid index rounded to edge * @return the first index of the string, or -1 if not found @@ -2527,7 +2527,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Searches the string builder to find the last reference to the specified char. - * + * * @param ch the character to find * @return the last index of the character, or -1 if not found */ @@ -2537,7 +2537,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Searches the string builder to find the last reference to the specified char. - * + * * @param ch the character to find * @param startIndex the index to start at, invalid index rounded to edge * @return the last index of the character, or -1 if not found @@ -2559,7 +2559,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * Searches the string builder to find the last reference to the specified string. * <p> * Note that a null input string will return -1, whereas the JDK throws an exception. - * + * * @param str the string to find, null returns -1 * @return the last index of the string, or -1 if not found */ @@ -2572,7 +2572,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build * string starting searching from the given index. * <p> * Note that a null input string will return -1, whereas the JDK throws an exception. - * + * * @param str the string to find, null returns -1 * @param startIndex the index to start at, invalid index rounded to edge * @return the last index of the string, or -1 if not found @@ -2597,7 +2597,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build } return i; } - + } else if (strLen == 0) { return startIndex; } @@ -2887,7 +2887,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build //----------------------------------------------------------------------- /** * Validates parameters defining a range of the builder. - * + * * @param startIndex the start index, inclusive, must be valid * @param endIndex the end index, exclusive, must be valid except * that if too large it is treated as end of string @@ -2909,7 +2909,7 @@ public class StrBuilder implements CharSequence, Appendable, Serializable, Build /** * Validates parameters defining a single index in the builder. - * + * * @param index the index, must be valid * @throws IndexOutOfBoundsException if the index is invalid */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/StrMatcher.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java index 0cfcd6f..60e0d45 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrMatcher.java +++ b/src/main/java/org/apache/commons/lang3/text/StrMatcher.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -378,7 +378,7 @@ public abstract class StrMatcher { } return len; } - + @Override public String toString() { return super.toString() + ' ' + Arrays.toString(chars); http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java index 68f8811..db5ed0a 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java +++ b/src/main/java/org/apache/commons/lang3/text/StrSubstitutor.java @@ -1209,7 +1209,7 @@ public class StrSubstitutor { /** * Returns the flag controlling whether escapes are preserved during * substitution. - * + * * @return the preserve escape flag * @since 3.5 */ @@ -1225,7 +1225,7 @@ public class StrSubstitutor { * character is removed during substitution (e.g. * <code>$${this-is-escaped}</code> becomes * <code>${this-is-escaped}</code>). The default value is <b>false</b> - * + * * @param preserveEscapes true if escapes are to be preserved * @since 3.5 */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java index 8d56b1d..f9fb6dc 100644 --- a/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java +++ b/src/main/java/org/apache/commons/lang3/text/StrTokenizer.java @@ -135,7 +135,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { /** * Returns a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>. - * + * * @return a clone of <code>CSV_TOKENIZER_PROTOTYPE</code>. */ private static StrTokenizer getCSVClone() { @@ -187,7 +187,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { /** * Returns a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>. - * + * * @return a clone of <code>TSV_TOKENIZER_PROTOTYPE</code>. */ private static StrTokenizer getTSVClone() { @@ -629,7 +629,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { * <code>StrTokenizer</code> will always pass a zero offset and a count * equal to the length of the array to this method, however a subclass * may pass other values, or even an entirely different array. - * + * * @param srcChars the character array being tokenized, may be null * @param offset the start position within the character array, must be valid * @param count the number of characters to tokenize, must be valid @@ -642,12 +642,12 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { final StrBuilder buf = new StrBuilder(); final List<String> tokenList = new ArrayList<>(); int pos = offset; - + // loop around the entire buffer while (pos >= 0 && pos < count) { // find next token pos = readNextToken(srcChars, pos, count, buf, tokenList); - + // handle case where end of string is a delimiter if (pos >= count) { addToken(tokenList, StringUtils.EMPTY); @@ -699,20 +699,20 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { } start += removeLen; } - + // handle reaching end if (start >= len) { addToken(tokenList, StringUtils.EMPTY); return -1; } - + // handle empty token final int delimLen = getDelimiterMatcher().isMatch(srcChars, start, start, len); if (delimLen > 0) { addToken(tokenList, StringUtils.EMPTY); return start + delimLen; } - + // handle found token final int quoteLen = getQuoteMatcher().isMatch(srcChars, start, start, len); if (quoteLen > 0) { @@ -735,7 +735,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { * immediately after the delimiter, or if end of string found, * then the length of string */ - private int readWithQuotes(final char[] srcChars, final int start, final int len, final StrBuilder workArea, + private int readWithQuotes(final char[] srcChars, final int start, final int len, final StrBuilder workArea, final List<String> tokenList, final int quoteStart, final int quoteLen) { // Loop until we've found the end of the quoted // string or the end of the input @@ -743,14 +743,14 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { int pos = start; boolean quoting = quoteLen > 0; int trimStart = 0; - + while (pos < len) { // quoting mode can occur several times throughout a string // we must switch between quoting and non-quoting until we // encounter a non-quoted delimiter, or end of string if (quoting) { // In quoting mode - + // If we've found a quote character, see if it's // followed by a second quote. If so, then we need // to actually put the quote character into the token @@ -763,20 +763,20 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { trimStart = workArea.size(); continue; } - + // end of quoting quoting = false; pos += quoteLen; continue; } - + // copy regular character from inside quotes workArea.append(srcChars[pos++]); trimStart = workArea.size(); - + } else { // Not in quoting mode - + // check for delimiter, and thus end of token final int delimLen = getDelimiterMatcher().isMatch(srcChars, pos, start, len); if (delimLen > 0) { @@ -784,21 +784,21 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { addToken(tokenList, workArea.substring(0, trimStart)); return pos + delimLen; } - + // check for quote, and thus back into quoting mode if (quoteLen > 0 && isQuote(srcChars, pos, len, quoteStart, quoteLen)) { quoting = true; pos += quoteLen; continue; } - + // check for ignored (outside quotes), and ignore final int ignoredLen = getIgnoredMatcher().isMatch(srcChars, pos, start, len); if (ignoredLen > 0) { pos += ignoredLen; continue; } - + // check for trimmed character // don't yet know if its at the end, so copy to workArea // use trimStart to keep track of trim at the end @@ -808,13 +808,13 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { pos += trimmedLen; continue; } - + // copy regular character from outside quotes workArea.append(srcChars[pos++]); trimStart = workArea.size(); } } - + // return condition when end of string found addToken(tokenList, workArea.substring(0, trimStart)); return -1; @@ -1071,7 +1071,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { * Creates a new instance of this Tokenizer. The new instance is reset so * that it will be at the start of the token list. * If a {@link CloneNotSupportedException} is caught, return <code>null</code>. - * + * * @return a new instance of this Tokenizer which has been reset. */ @Override @@ -1086,7 +1086,7 @@ public class StrTokenizer implements ListIterator<String>, Cloneable { /** * Creates a new instance of this Tokenizer. The new instance is reset so that * it will be at the start of the token list. - * + * * @return a new instance of this Tokenizer which has been reset. * @throws CloneNotSupportedException if there is a problem cloning */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/WordUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/WordUtils.java b/src/main/java/org/apache/commons/lang3/text/WordUtils.java index 66ce445..fef20d0 100644 --- a/src/main/java/org/apache/commons/lang3/text/WordUtils.java +++ b/src/main/java/org/apache/commons/lang3/text/WordUtils.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -24,11 +24,11 @@ import org.apache.commons.lang3.StringUtils; /** * <p>Operations on Strings that contain words.</p> - * + * * <p>This class tries to handle <code>null</code> input gracefully. * An exception will not be thrown for a <code>null</code> input. * Each method documents its behaviour in more detail.</p> - * + * * @since 2.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/WordUtils.html";> @@ -53,10 +53,10 @@ public class WordUtils { //-------------------------------------------------------------------------- /** * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p> - * + * * <p>New lines will be separated by the system property line separator. * Very long words, such as URLs will <i>not</i> be wrapped.</p> - * + * * <p>Leading spaces on a new line are stripped. * Trailing spaces are not stripped.</p> * @@ -102,10 +102,10 @@ public class WordUtils { public static String wrap(final String str, final int wrapLength) { return wrap(str, wrapLength, null, false); } - + /** * <p>Wraps a single line of text, identifying words by <code>' '</code>.</p> - * + * * <p>Leading spaces on a new line are stripped. * Trailing spaces are not stripped.</p> * @@ -170,7 +170,7 @@ public class WordUtils { * * @param str the String to be word wrapped, may be null * @param wrapLength the column to wrap the words at, less than 1 is treated as 1 - * @param newLineStr the string to insert for a new line, + * @param newLineStr the string to insert for a new line, * <code>null</code> uses the system property line separator * @param wrapLongWords true if long words (such as URLs) should be wrapped * @return a line with newlines inserted, <code>null</code> if null input @@ -348,8 +348,8 @@ public class WordUtils { //----------------------------------------------------------------------- /** * <p>Capitalizes all the whitespace separated words in a String. - * Only the first character of each word is changed. To convert the - * rest of each word to lowercase at the same time, + * Only the first character of each word is changed. To convert the + * rest of each word to lowercase at the same time, * use {@link #capitalizeFully(String)}.</p> * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}. @@ -362,7 +362,7 @@ public class WordUtils { * WordUtils.capitalize("") = "" * WordUtils.capitalize("i am FINE") = "I Am FINE" * </pre> - * + * * @param str the String to capitalize, may be null * @return capitalized String, <code>null</code> if null String input * @see #uncapitalize(String) @@ -374,8 +374,8 @@ public class WordUtils { /** * <p>Capitalizes all the delimiter separated words in a String. - * Only the first character of each word is changed. To convert the - * rest of each word to lowercase at the same time, + * Only the first character of each word is changed. To convert the + * rest of each word to lowercase at the same time, * use {@link #capitalizeFully(String, char[])}.</p> * * <p>The delimiters represent a set of characters understood to separate words. @@ -393,7 +393,7 @@ public class WordUtils { * WordUtils.capitalize("i am fine", null) = "I Am Fine" * WordUtils.capitalize("i aM.fine", {'.'}) = "I aM.Fine" * </pre> - * + * * @param str the String to capitalize, may be null * @param delimiters set of characters to determine capitalization, null means whitespace * @return capitalized String, <code>null</code> if null String input @@ -422,8 +422,8 @@ public class WordUtils { //----------------------------------------------------------------------- /** - * <p>Converts all the whitespace separated words in a String into capitalized words, - * that is each word is made up of a titlecase character and then a series of + * <p>Converts all the whitespace separated words in a String into capitalized words, + * that is each word is made up of a titlecase character and then a series of * lowercase characters. </p> * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}. @@ -436,7 +436,7 @@ public class WordUtils { * WordUtils.capitalizeFully("") = "" * WordUtils.capitalizeFully("i am FINE") = "I Am Fine" * </pre> - * + * * @param str the String to capitalize, may be null * @return capitalized String, <code>null</code> if null String input */ @@ -445,8 +445,8 @@ public class WordUtils { } /** - * <p>Converts all the delimiter separated words in a String into capitalized words, - * that is each word is made up of a titlecase character and then a series of + * <p>Converts all the delimiter separated words in a String into capitalized words, + * that is each word is made up of a titlecase character and then a series of * lowercase characters. </p> * * <p>The delimiters represent a set of characters understood to separate words. @@ -464,7 +464,7 @@ public class WordUtils { * WordUtils.capitalizeFully(*, new char[0]) = * * WordUtils.capitalizeFully("i aM.fine", {'.'}) = "I am.Fine" * </pre> - * + * * @param str the String to capitalize, may be null * @param delimiters set of characters to determine capitalization, null means whitespace * @return capitalized String, <code>null</code> if null String input @@ -492,7 +492,7 @@ public class WordUtils { * WordUtils.uncapitalize("") = "" * WordUtils.uncapitalize("I Am FINE") = "i am fINE" * </pre> - * + * * @param str the String to uncapitalize, may be null * @return uncapitalized String, <code>null</code> if null String input * @see #capitalize(String) @@ -519,7 +519,7 @@ public class WordUtils { * WordUtils.uncapitalize(*, new char[0]) = * * WordUtils.uncapitalize("I AM.FINE", {'.'}) = "i AM.fINE" * </pre> - * + * * @param str the String to uncapitalize, may be null * @param delimiters set of characters to determine uncapitalization, null means whitespace * @return uncapitalized String, <code>null</code> if null String input @@ -548,23 +548,23 @@ public class WordUtils { //----------------------------------------------------------------------- /** * <p>Swaps the case of a String using a word based algorithm.</p> - * + * * <ul> * <li>Upper case character converts to Lower case</li> * <li>Title case character converts to Lower case</li> * <li>Lower case character after Whitespace or at start converts to Title case</li> * <li>Other Lower case character converts to Upper case</li> * </ul> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}. * A <code>null</code> input String returns <code>null</code>.</p> - * + * * <pre> * StringUtils.swapCase(null) = null * StringUtils.swapCase("") = "" * StringUtils.swapCase("The dog has a BONE") = "tHE DOG HAS A bone" * </pre> - * + * * @param str the String to swap case, may be null * @return the changed String, <code>null</code> if null String input */ @@ -601,7 +601,7 @@ public class WordUtils { //----------------------------------------------------------------------- /** * <p>Extracts the initial characters from each word in the String.</p> - * + * * <p>All first characters after whitespace are returned as a new string. * Their case is not changed.</p> * @@ -626,7 +626,7 @@ public class WordUtils { /** * <p>Extracts the initial characters from each word in the String.</p> - * + * * <p>All first characters after the defined delimiters are returned as a new string. * Their case is not changed.</p> * @@ -643,7 +643,7 @@ public class WordUtils { * WordUtils.initials("Ben J.Lee", [' ','.']) = "BJL" * WordUtils.initials(*, new char[0]) = "" * </pre> - * + * * @param str the String to get initials from, may be null * @param delimiters set of characters to determine words, null means whitespace * @return String of initial characters, <code>null</code> if null String input http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/AggregateTranslator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/AggregateTranslator.java b/src/main/java/org/apache/commons/lang3/text/translate/AggregateTranslator.java index 6f4519c..86b22bb 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/AggregateTranslator.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/AggregateTranslator.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,9 +22,9 @@ import java.io.Writer; import org.apache.commons.lang3.ArrayUtils; /** - * Executes a sequence of translators one after the other. Execution ends whenever + * Executes a sequence of translators one after the other. Execution ends whenever * the first translator consumes codepoints from the input. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/AggregateTranslator.html";> @@ -36,7 +36,7 @@ public class AggregateTranslator extends CharSequenceTranslator { private final CharSequenceTranslator[] translators; /** - * Specify the translators to be used at creation time. + * Specify the translators to be used at creation time. * * @param translators CharSequenceTranslator array to aggregate */ @@ -45,8 +45,8 @@ public class AggregateTranslator extends CharSequenceTranslator { } /** - * The first translator to consume codepoints from the input is the 'winner'. - * Execution stops with the number of consumed codepoints being returned. + * The first translator to consume codepoints from the input is the 'winner'. + * Execution stops with the number of consumed codepoints being returned. * {@inheritDoc} */ @Override http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java index 17fb8ac..e79ebe6 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/CharSequenceTranslator.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,10 +22,10 @@ import java.io.Writer; import java.util.Locale; /** - * An API for translating text. - * Its core use is to escape and unescape text. Because escaping and unescaping + * An API for translating text. + * Its core use is to escape and unescape text. Because escaping and unescaping * is completely contextual, the API does not present two separate signatures. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CharSequenceTranslator.html";> @@ -37,10 +37,10 @@ public abstract class CharSequenceTranslator { static final char[] HEX_DIGITS = new char[] {'0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'}; /** - * Translate a set of codepoints, represented by an int index into a CharSequence, - * into another set of codepoints. The number of codepoints consumed must be returned, - * and the only IOExceptions thrown must be from interacting with the Writer so that - * the top level API may reliably ignore StringWriter IOExceptions. + * Translate a set of codepoints, represented by an int index into a CharSequence, + * into another set of codepoints. The number of codepoints consumed must be returned, + * and the only IOExceptions thrown must be from interacting with the Writer so that + * the top level API may reliably ignore StringWriter IOExceptions. * * @param input CharSequence that is being translated * @param index int representing the current point of translation @@ -51,7 +51,7 @@ public abstract class CharSequenceTranslator { public abstract int translate(CharSequence input, int index, Writer out) throws IOException; /** - * Helper for non-Writer usage. + * Helper for non-Writer usage. * @param input CharSequence to be translated * @return String output of translation */ @@ -70,8 +70,8 @@ public abstract class CharSequenceTranslator { } /** - * Translate an input onto a Writer. This is intentionally final as its algorithm is - * tightly coupled with the abstract method of this class. + * Translate an input onto a Writer. This is intentionally final as its algorithm is + * tightly coupled with the abstract method of this class. * * @param input CharSequence that is being translated * @param out Writer to translate the text to @@ -112,7 +112,7 @@ public abstract class CharSequenceTranslator { } /** - * Helper method to create a merger of this translator with another set of + * Helper method to create a merger of this translator with another set of * translators. Useful in customizing the standard functionality. * * @param translators CharSequenceTranslator array of translators to merge with this one http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java index 92ed505..003dd77 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/CodePointTranslator.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -20,9 +20,9 @@ import java.io.IOException; import java.io.Writer; /** - * Helper subclass to CharSequenceTranslator to allow for translations that + * Helper subclass to CharSequenceTranslator to allow for translations that * will replace up to one character at a time. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/CodePointTranslator.html";> @@ -32,19 +32,19 @@ import java.io.Writer; public abstract class CodePointTranslator extends CharSequenceTranslator { /** - * Implementation of translate that maps onto the abstract translate(int, Writer) method. + * Implementation of translate that maps onto the abstract translate(int, Writer) method. * {@inheritDoc} */ @Override public final int translate(final CharSequence input, final int index, final Writer out) throws IOException { final int codepoint = Character.codePointAt(input, index); final boolean consumed = translate(codepoint, out); - return consumed ? 1 : 0; + return consumed ? 1 : 0; } /** - * Translate the specified codepoint into another. - * + * Translate the specified codepoint into another. + * * @param codepoint int character input to translate * @param out Writer to optionally push the translated output to * @return boolean as to whether translation occurred or not http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/JavaUnicodeEscaper.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/JavaUnicodeEscaper.java b/src/main/java/org/apache/commons/lang3/text/translate/JavaUnicodeEscaper.java index d02a057..150cfaf 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/JavaUnicodeEscaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/JavaUnicodeEscaper.java @@ -18,7 +18,7 @@ package org.apache.commons.lang3.text.translate; /** * Translates codepoints to their Unicode escaped value suitable for Java source. - * + * * @since 3.2 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeEscaper.html";> @@ -31,7 +31,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { * <p> * Constructs a <code>JavaUnicodeEscaper</code> above the specified value (exclusive). * </p> - * + * * @param codepoint * above which to escape * @return the newly created {@code UnicodeEscaper} instance @@ -44,7 +44,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { * <p> * Constructs a <code>JavaUnicodeEscaper</code> below the specified value (exclusive). * </p> - * + * * @param codepoint * below which to escape * @return the newly created {@code UnicodeEscaper} instance @@ -57,7 +57,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { * <p> * Constructs a <code>JavaUnicodeEscaper</code> between the specified values (inclusive). * </p> - * + * * @param codepointLow * above which to escape * @param codepointHigh @@ -72,7 +72,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { * <p> * Constructs a <code>JavaUnicodeEscaper</code> outside of the specified values (exclusive). * </p> - * + * * @param codepointLow * below which to escape * @param codepointHigh @@ -89,7 +89,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { * 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 @@ -103,7 +103,7 @@ public class JavaUnicodeEscaper extends UnicodeEscaper { /** * Converts the given codepoint to a hex string of the form {@code "\\uXXXX\\uXXXX"} - * + * * @param codepoint * a Unicode code point * @return the hex string for the given codepoint http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java b/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java index e00983e..5e80154 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java index bfb5f85..d01a420 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,11 +22,11 @@ import java.util.Arrays; import java.util.EnumSet; /** - * Translate XML numeric entities of the form &#[xX]?\d+;? to + * Translate XML numeric entities of the form &#[xX]?\d+;? to * the specific codepoint. * * Note that the semi-colon is optional. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/NumericEntityUnescaper.html";> @@ -43,8 +43,8 @@ public class NumericEntityUnescaper extends CharSequenceTranslator { /** * Create a UnicodeUnescaper. * - * The constructor takes a list of options, only one type of which is currently - * available (whether to allow, error or ignore the semi-colon on the end of a + * The constructor takes a list of options, only one type of which is currently + * available (whether to allow, error or ignore the semi-colon on the end of a * numeric entity to being missing). * * For example, to support numeric entities without a ';': @@ -52,7 +52,7 @@ public class NumericEntityUnescaper extends CharSequenceTranslator { * and to throw an IllegalArgumentException when they're missing: * new NumericEntityUnescaper(NumericEntityUnescaper.OPTION.errorIfNoSemiColon) * - * Note that the default behaviour is to ignore them. + * Note that the default behaviour is to ignore them. * * @param options to apply to this unescaper */ @@ -70,7 +70,7 @@ public class NumericEntityUnescaper extends CharSequenceTranslator { * @param option to check state of * @return whether the option is set */ - public boolean isSet(final OPTION option) { + public boolean isSet(final OPTION option) { return options == null ? false : options.contains(option); } http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java b/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java index 5a27d50..e8ac357 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/OctalUnescaper.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -24,9 +24,9 @@ import java.io.Writer; * * For example, "\45" should go back to being the specific value (a %). * - * Note that this currently only supports the viable range of octal for Java; namely + * Note that this currently only supports the viable range of octal for Java; namely * 1 to 377. This is because parsing Java is the main use case. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/OctalUnescaper.html";> http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java index b7ee38f..5771d15 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeEscaper.java @@ -129,7 +129,7 @@ public class UnicodeEscaper extends CodePointTranslator { /** * Converts the given codepoint to a hex string of the form {@code "\\uXXXX"} - * + * * @param codepoint * a Unicode code point * @return the hex string for the given codepoint http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java index 0f2fd25..52d8df4 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnescaper.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -20,10 +20,10 @@ import java.io.IOException; import java.io.Writer; /** - * Translates escaped Unicode values of the form \\u+\d\d\d\d back to - * Unicode. It supports multiple 'u' characters and will work with or + * Translates escaped Unicode values of the form \\u+\d\d\d\d back to + * Unicode. It supports multiple 'u' characters and will work with or * without the +. - * + * * @since 3.0 * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnescaper.html";> http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java index 39249c3..0115422 100644 --- a/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java +++ b/src/main/java/org/apache/commons/lang3/text/translate/UnicodeUnpairedSurrogateRemover.java @@ -21,7 +21,7 @@ import java.io.Writer; /** * Helper subclass to CharSequenceTranslator to remove unpaired surrogates. - * + * * @deprecated as of 3.6, use commons-text * <a href="https://commons.apache.org/proper/commons-text/javadocs/api-release/org/apache/commons/text/translate/UnicodeUnpairedSurrogateRemover.html";> * UnicodeUnpairedSurrogateRemover</a> instead @@ -29,7 +29,7 @@ import java.io.Writer; @Deprecated public class UnicodeUnpairedSurrogateRemover extends CodePointTranslator { /** - * Implementation of translate that throws out unpaired surrogates. + * Implementation of translate that throws out unpaired surrogates. * {@inheritDoc} */ @Override http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java index 3f78753..09d2c52 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java +++ b/src/main/java/org/apache/commons/lang3/time/DateFormatUtils.java @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -27,7 +27,7 @@ import java.util.TimeZone; * <p>Formatting is performed using the thread-safe * {@link org.apache.commons.lang3.time.FastDateFormat} class.</p> * - * <p>Note that the JDK has a bug wherein calling Calendar.get(int) will + * <p>Note that the JDK has a bug wherein calling Calendar.get(int) will * override any previously called Calendar.clear() calls. See LANG-755.</p> * * @since 2.0 @@ -206,7 +206,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern using the UTC time zone.</p> - * + * * @param millis the date to format expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @return the formatted date @@ -217,7 +217,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern using the UTC time zone.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null * @return the formatted date @@ -225,10 +225,10 @@ public class DateFormatUtils { public static String formatUTC(final Date date, final String pattern) { return format(date, pattern, UTC_TIME_ZONE, null); } - + /** * <p>Formats a date/time into a specific pattern using the UTC time zone.</p> - * + * * @param millis the date to format expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @param locale the locale to use, may be <code>null</code> @@ -240,7 +240,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern using the UTC time zone.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null * @param locale the locale to use, may be <code>null</code> @@ -249,10 +249,10 @@ public class DateFormatUtils { public static String formatUTC(final Date date, final String pattern, final Locale locale) { return format(date, pattern, UTC_TIME_ZONE, locale); } - + /** * <p>Formats a date/time into a specific pattern.</p> - * + * * @param millis the date to format expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @return the formatted date @@ -263,7 +263,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null * @return the formatted date @@ -274,7 +274,7 @@ public class DateFormatUtils { /** * <p>Formats a calendar into a specific pattern.</p> - * + * * @param calendar the calendar to format, not null * @param pattern the pattern to use to format the calendar, not null * @return the formatted calendar @@ -284,10 +284,10 @@ public class DateFormatUtils { public static String format(final Calendar calendar, final String pattern) { return format(calendar, pattern, null, null); } - + /** * <p>Formats a date/time into a specific pattern in a time zone.</p> - * + * * @param millis the time expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @param timeZone the time zone to use, may be <code>null</code> @@ -299,7 +299,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern in a time zone.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null * @param timeZone the time zone to use, may be <code>null</code> @@ -311,7 +311,7 @@ public class DateFormatUtils { /** * <p>Formats a calendar into a specific pattern in a time zone.</p> - * + * * @param calendar the calendar to format, not null * @param pattern the pattern to use to format the calendar, not null * @param timeZone the time zone to use, may be <code>null</code> @@ -325,7 +325,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern in a locale.</p> - * + * * @param millis the date to format expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @param locale the locale to use, may be <code>null</code> @@ -337,7 +337,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern in a locale.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null * @param locale the locale to use, may be <code>null</code> @@ -349,7 +349,7 @@ public class DateFormatUtils { /** * <p>Formats a calendar into a specific pattern in a locale.</p> - * + * * @param calendar the calendar to format, not null * @param pattern the pattern to use to format the calendar, not null * @param locale the locale to use, may be <code>null</code> @@ -363,7 +363,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern in a time zone and locale.</p> - * + * * @param millis the date to format expressed in milliseconds * @param pattern the pattern to use to format the date, not null * @param timeZone the time zone to use, may be <code>null</code> @@ -376,7 +376,7 @@ public class DateFormatUtils { /** * <p>Formats a date/time into a specific pattern in a time zone and locale.</p> - * + * * @param date the date to format, not null * @param pattern the pattern to use to format the date, not null, not null * @param timeZone the time zone to use, may be <code>null</code> @@ -390,7 +390,7 @@ public class DateFormatUtils { /** * <p>Formats a calendar into a specific pattern in a time zone and locale.</p> - * + * * @param calendar the calendar to format, not null * @param pattern the pattern to use to format the calendar, not null * @param timeZone the time zone to use, may be <code>null</code> http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/time/DateParser.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/time/DateParser.java b/src/main/java/org/apache/commons/lang3/time/DateParser.java index 3702603..2836e9e 100644 --- a/src/main/java/org/apache/commons/lang3/time/DateParser.java +++ b/src/main/java/org/apache/commons/lang3/time/DateParser.java @@ -30,30 +30,30 @@ import java.util.TimeZone; * <p> * Warning: Since binary compatible methods may be added to this interface in any * release, developers are not expected to implement this interface. - * + * * @since 3.2 */ public interface DateParser { /** - * Equivalent to DateFormat.parse(String). - * - * See {@link java.text.DateFormat#parse(String)} for more information. - * @param source A <code>String</code> whose beginning should be parsed. + * Equivalent to DateFormat.parse(String). + * + * See {@link java.text.DateFormat#parse(String)} for more information. + * @param source A <code>String</code> whose beginning should be parsed. * @return A <code>Date</code> parsed from the string * @throws ParseException if the beginning of the specified string cannot be parsed. */ Date parse(String source) throws ParseException; /** - * Equivalent to DateFormat.parse(String, ParsePosition). - * - * See {@link java.text.DateFormat#parse(String, ParsePosition)} for more information. - * + * Equivalent to DateFormat.parse(String, ParsePosition). + * + * See {@link java.text.DateFormat#parse(String, ParsePosition)} for more information. + * * @param source A <code>String</code>, part of which should be parsed. - * @param pos A <code>ParsePosition</code> object with index and error index information - * as described above. - * @return A <code>Date</code> parsed from the string. In case of error, returns null. + * @param pos A <code>ParsePosition</code> object with index and error index information + * as described above. + * @return A <code>Date</code> parsed from the string. In case of error, returns null. * @throws NullPointerException if text or pos is null. */ Date parse(String source, ParsePosition pos); @@ -70,7 +70,7 @@ public interface DateParser { * @return true, if source has been parsed (pos parsePosition is updated); otherwise false (and pos errorIndex is updated) * @throws IllegalArgumentException when Calendar has been set to be not lenient, and a parsed field is * out of range. - * + * * @since 3.5 */ boolean parse(String source, ParsePosition pos, Calendar calendar); @@ -79,7 +79,7 @@ public interface DateParser { //----------------------------------------------------------------------- /** * <p>Gets the pattern used by this parser.</p> - * + * * @return the pattern, {@link java.text.SimpleDateFormat} compatible */ String getPattern(); @@ -88,40 +88,40 @@ public interface DateParser { * <p> * Gets the time zone used by this parser. * </p> - * + * * <p> * The default {@link TimeZone} used to create a {@link Date} when the {@link TimeZone} is not specified by * the format pattern. * </p> - * + * * @return the time zone */ TimeZone getTimeZone(); /** * <p>Gets the locale used by this parser.</p> - * + * * @return the locale */ Locale getLocale(); /** * Parses text from a string to produce a Date. - * + * * @param source A <code>String</code> whose beginning should be parsed. * @return a <code>java.util.Date</code> object * @throws ParseException if the beginning of the specified string cannot be parsed. - * @see java.text.DateFormat#parseObject(String) + * @see java.text.DateFormat#parseObject(String) */ Object parseObject(String source) throws ParseException; /** * Parses a date/time string according to the given parse position. - * + * * @param source A <code>String</code> whose beginning should be parsed. * @param pos the parse position * @return a <code>java.util.Date</code> object - * @see java.text.DateFormat#parseObject(String, ParsePosition) + * @see java.text.DateFormat#parseObject(String, ParsePosition) */ Object parseObject(String source, ParsePosition pos); } http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/time/DatePrinter.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/time/DatePrinter.java b/src/main/java/org/apache/commons/lang3/time/DatePrinter.java index 342405a..eebcbee 100644 --- a/src/main/java/org/apache/commons/lang3/time/DatePrinter.java +++ b/src/main/java/org/apache/commons/lang3/time/DatePrinter.java @@ -23,13 +23,13 @@ import java.util.Locale; import java.util.TimeZone; /** - * DatePrinter is the "missing" interface for the format methods of + * DatePrinter is the "missing" interface for the format methods of * {@link java.text.DateFormat}. You can obtain an object implementing this * interface by using one of the FastDateFormat factory methods. * <p> * Warning: Since binary compatible methods may be added to this interface in any * release, developers are not expected to implement this interface. - * + * * @since 3.2 */ public interface DatePrinter {
