http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/NotImplementedException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/NotImplementedException.java b/src/main/java/org/apache/commons/lang3/NotImplementedException.java index 82e3784..d7e2e75 100644 --- a/src/main/java/org/apache/commons/lang3/NotImplementedException.java +++ b/src/main/java/org/apache/commons/lang3/NotImplementedException.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,11 +20,11 @@ package org.apache.commons.lang3; * <p>Thrown to indicate that a block of code has not been implemented. * This exception supplements <code>UnsupportedOperationException</code> * by providing a more semantically rich description of the problem.</p> - * + * * <p><code>NotImplementedException</code> represents the case where the * author has yet to implement the logic at this point in the program. * This can act as an exception based TODO tag. </p> - * + * * <pre> * public void foo() { * try { @@ -38,7 +38,7 @@ package org.apache.commons.lang3; * * This class was originally added in Lang 2.0, but removed in 3.0. * - * @since 3.2 + * @since 3.2 */ public class NotImplementedException extends UnsupportedOperationException { @@ -48,7 +48,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param message description of the exception * @since 3.2 */ @@ -58,7 +58,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param cause cause of the exception * @since 3.2 */ @@ -68,7 +68,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param message description of the exception * @param cause cause of the exception * @since 3.2 @@ -79,7 +79,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param message description of the exception * @param code code indicating a resource for more information regarding the lack of implementation * @since 3.2 @@ -91,7 +91,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param cause cause of the exception * @param code code indicating a resource for more information regarding the lack of implementation * @since 3.2 @@ -103,7 +103,7 @@ public class NotImplementedException extends UnsupportedOperationException { /** * Constructs a NotImplementedException. - * + * * @param message description of the exception * @param cause cause of the exception * @param code code indicating a resource for more information regarding the lack of implementation @@ -115,8 +115,8 @@ public class NotImplementedException extends UnsupportedOperationException { } /** - * Obtain the not implemented code. This is an unformatted piece of text intended to point to - * further information regarding the lack of implementation. It might, for example, be an issue + * Obtain the not implemented code. This is an unformatted piece of text intended to point to + * further information regarding the lack of implementation. It might, for example, be an issue * tracker ID or a URL. * * @return a code indicating a resource for more information regarding the lack of implementation
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/ObjectUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/ObjectUtils.java b/src/main/java/org/apache/commons/lang3/ObjectUtils.java index b5a00db..146556b 100644 --- a/src/main/java/org/apache/commons/lang3/ObjectUtils.java +++ b/src/main/java/org/apache/commons/lang3/ObjectUtils.java @@ -147,7 +147,7 @@ public class ObjectUtils { * ObjectUtils.anyNotNull(null) = false * ObjectUtils.anyNotNull(null, null) = false * </pre> - * + * * @param values the values to test, may be {@code null} or empty * @return {@code true} if there is at least one non-null value in the array, * {@code false} if all values in the array are {@code null}s. @@ -167,7 +167,7 @@ public class ObjectUtils { * {@code null} or the array is empty (contains no elements) {@code true} * is returned. * </p> - * + * * <pre> * ObjectUtils.allNotNull(*) = true * ObjectUtils.allNotNull(*, *) = true @@ -277,7 +277,7 @@ public class ObjectUtils { /** * <p>Gets the hash code for multiple objects.</p> - * + * * <p>This allows a hash code to be rapidly calculated for a number of objects. * The hash code for a single object is the <em>not</em> same as {@link #hashCode(Object)}. * The hash code for multiple objects is the same as that calculated by an @@ -622,7 +622,7 @@ public class ObjectUtils { //----------------------------------------------------------------------- /** * Find the most frequently occurring item. - * + * * @param <T> type of values processed by this method * @param items to check * @return most populous T, {@code null} if non-unique or no items supplied @@ -1008,7 +1008,7 @@ public class ObjectUtils { * have to recompile themselves if the field's value * changes at some future date. * - * @param <T> the Object type + * @param <T> the Object type * @param v the genericized Object value to return (typically a String). * @return the genericized Object v, unchanged (typically a String). * @since 3.2 http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/RandomStringUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java b/src/main/java/org/apache/commons/lang3/RandomStringUtils.java index c5e256b..25bfe31 100644 --- a/src/main/java/org/apache/commons/lang3/RandomStringUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomStringUtils.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,13 +20,13 @@ import java.util.Random; /** * <p>Operations for random {@code String}s.</p> - * <p>Currently <em>private high surrogate</em> characters are ignored. + * <p>Currently <em>private high surrogate</em> characters are ignored. * These are Unicode characters that fall between the values 56192 (db80) - * and 56319 (dbff) as we don't know how to handle them. - * High and low surrogates are correctly dealt with - that is if a - * high surrogate is randomly chosen, 55296 (d800) to 56191 (db7f) - * then it is followed by a low surrogate. If a low surrogate is chosen, - * 56320 (dc00) to 57343 (dfff) then it is placed after a randomly + * and 56319 (dbff) as we don't know how to handle them. + * High and low surrogates are correctly dealt with - that is if a + * high surrogate is randomly chosen, 55296 (d800) to 56191 (db7f) + * then it is followed by a low surrogate. If a low surrogate is chosen, + * 56320 (dc00) to 57343 (dfff) then it is placed after a randomly * chosen high surrogate. </p> * * <p>#ThreadSafe#</p> @@ -40,7 +40,7 @@ public class RandomStringUtils { /** * <p>Random object used by random method. This has to be not local - * to the random method so as to not return the same value in the + * to the random method so as to not return the same value in the * same millisecond.</p> */ private static final Random RANDOM = new Random(); @@ -165,7 +165,7 @@ public class RandomStringUtils { * <p>Creates a random string whose length is the number of characters specified.</p> * * <p>Characters will be chosen from the set of characters which match the POSIX [:graph:] - * regular expression character class. This class contains all visible ASCII characters + * regular expression character class. This class contains all visible ASCII characters * (i.e. anything except spaces and control characters).</p> * * @param count the length of random string to create @@ -267,7 +267,7 @@ public class RandomStringUtils { public static String random(final int count, final boolean letters, final boolean numbers) { return random(count, 0, 0, letters, numbers); } - + /** * <p>Creates a random string whose length is the number of characters * specified.</p> @@ -326,7 +326,7 @@ public class RandomStringUtils { * end are chosen.</p> * * <p>This method accepts a user-supplied {@link Random} - * instance to use as a source of randomness. By seeding a single + * instance to use as a source of randomness. By seeding a single * {@link Random} instance with a fixed seed and using it for each call, * the same random sequence of strings can be generated repeatedly * and predictably.</p> @@ -364,7 +364,7 @@ public class RandomStringUtils { end = Character.MAX_CODE_POINT; } else { end = 'z' + 1; - start = ' '; + start = ' '; } } } else { @@ -389,7 +389,7 @@ public class RandomStringUtils { int codePoint; if (chars == null) { codePoint = random.nextInt(gap) + start; - + switch (Character.getType(codePoint)) { case Character.UNASSIGNED: case Character.PRIVATE_USE: @@ -397,26 +397,26 @@ public class RandomStringUtils { count++; continue; } - + } else { codePoint = chars[random.nextInt(gap) + start]; } - + final int numberOfChars = Character.charCount(codePoint); if (count == 0 && numberOfChars > 1) { count++; continue; } - + if (letters && Character.isLetter(codePoint) || numbers && Character.isDigit(codePoint) - || !letters && !numbers) { + || !letters && !numbers) { builder.appendCodePoint(codePoint); - + if (numberOfChars == 2) { count--; } - + } else { count++; } @@ -430,7 +430,7 @@ public class RandomStringUtils { * specified.</p> * * <p>Characters will be chosen from the set of characters - * specified by the string, must not be empty. + * specified by the string, must not be empty. * If null, the set of all characters is used.</p> * * @param count the length of random string to create @@ -464,5 +464,5 @@ public class RandomStringUtils { } return random(count, 0, chars.length, false, false, chars, RANDOM); } - + } http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/RandomUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/RandomUtils.java b/src/main/java/org/apache/commons/lang3/RandomUtils.java index 3ea4493..e999293 100644 --- a/src/main/java/org/apache/commons/lang3/RandomUtils.java +++ b/src/main/java/org/apache/commons/lang3/RandomUtils.java @@ -20,7 +20,7 @@ import java.util.Random; /** * <p>Utility library that supplements the standard {@link Random} class.</p> - * + * * @since 3.3 */ public class RandomUtils { @@ -37,7 +37,7 @@ public class RandomUtils { * programming. Instead, the class should be used as * {@code RandomUtils.nextBytes(5);}. * </p> - * + * * <p> * This constructor is public to permit tools that require a JavaBean * instance to operate. @@ -58,12 +58,12 @@ public class RandomUtils { public static boolean nextBoolean() { return RANDOM.nextBoolean(); } - + /** * <p> * Creates an array of random bytes. * </p> - * + * * @param count * the size of the returned array * @return the random byte array @@ -81,7 +81,7 @@ public class RandomUtils { * <p> * Returns a random integer within the specified range. * </p> - * + * * @param startInclusive * the smallest value that can be returned, must be non-negative * @param endExclusive @@ -99,7 +99,7 @@ public class RandomUtils { if (startInclusive == endExclusive) { return startInclusive; } - + return startInclusive + RANDOM.nextInt(endExclusive - startInclusive); } @@ -113,12 +113,12 @@ public class RandomUtils { public static int nextInt() { return nextInt(0, Integer.MAX_VALUE); } - + /** * <p> * Returns a random long within the specified range. * </p> - * + * * @param startInclusive * the smallest value that can be returned, must be non-negative * @param endExclusive @@ -150,12 +150,12 @@ public class RandomUtils { public static long nextLong() { return nextLong(0, Long.MAX_VALUE); } - + /** - * <p> + * <p> * Returns a random double within the specified range. * </p> - * + * * @param startInclusive * the smallest value that can be returned, must be non-negative * @param endInclusive @@ -173,7 +173,7 @@ public class RandomUtils { if (startInclusive == endInclusive) { return startInclusive; } - + return startInclusive + ((endInclusive - startInclusive) * RANDOM.nextDouble()); } @@ -192,7 +192,7 @@ public class RandomUtils { * <p> * Returns a random float within the specified range. * </p> - * + * * @param startInclusive * the smallest value that can be returned, must be non-negative * @param endInclusive @@ -206,11 +206,11 @@ public class RandomUtils { Validate.isTrue(endInclusive >= startInclusive, "Start value must be smaller or equal to end value."); Validate.isTrue(startInclusive >= 0, "Both range values must be non-negative."); - + if (startInclusive == endInclusive) { return startInclusive; } - + return startInclusive + ((endInclusive - startInclusive) * RANDOM.nextFloat()); } http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/Range.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/Range.java b/src/main/java/org/apache/commons/lang3/Range.java index 29ad7a3..5962f80 100644 --- a/src/main/java/org/apache/commons/lang3/Range.java +++ b/src/main/java/org/apache/commons/lang3/Range.java @@ -21,12 +21,12 @@ import java.util.Comparator; /** * <p>An immutable range of objects from a minimum to maximum point inclusive.</p> - * + * * <p>The objects need to either be implementations of {@code Comparable} * or you need to supply a {@code Comparator}. </p> * * <p>#ThreadSafe# if the objects and comparator are thread-safe</p> - * + * * @since 3.0 */ public final class Range<T> implements Serializable { @@ -61,7 +61,7 @@ public final class Range<T> implements Serializable { /** * <p>Obtains a range using the specified element as both the minimum * and maximum in this range.</p> - * + * * <p>The range uses the natural ordering of the elements to determine where * values lie in the range.</p> * @@ -78,7 +78,7 @@ public final class Range<T> implements Serializable { /** * <p>Obtains a range using the specified element as both the minimum * and maximum in this range.</p> - * + * * <p>The range uses the specified {@code Comparator} to determine where * values lie in the range.</p> * @@ -95,7 +95,7 @@ public final class Range<T> implements Serializable { /** * <p>Obtains a range with the specified minimum and maximum values (both inclusive).</p> - * + * * <p>The range uses the natural ordering of the elements to determine where * values lie in the range.</p> * @@ -115,7 +115,7 @@ public final class Range<T> implements Serializable { /** * <p>Obtains a range with the specified minimum and maximum values (both inclusive).</p> - * + * * <p>The range uses the specified {@code Comparator} to determine where * values lie in the range.</p> * @@ -150,7 +150,7 @@ public final class Range<T> implements Serializable { if (comp == null) { this.comparator = ComparableComparator.INSTANCE; } else { - this.comparator = comp; + this.comparator = comp; } if (this.comparator.compare(element1, element2) < 1) { this.minimum = element1; @@ -184,7 +184,7 @@ public final class Range<T> implements Serializable { /** * <p>Gets the comparator being used to determine if objects are within the range.</p> - * + * * <p>Natural ordering uses an internal comparator implementation, thus this * method never returns null. See {@link #isNaturalOrdering()}.</p> * @@ -196,7 +196,7 @@ public final class Range<T> implements Serializable { /** * <p>Whether or not the Range is using the natural ordering of the elements.</p> - * + * * <p>Natural ordering uses an internal comparator implementation, thus this * method is the only way to check if a null comparator was specified.</p> * @@ -276,7 +276,7 @@ public final class Range<T> implements Serializable { /** * <p>Checks where the specified element occurs relative to this range.</p> - * + * * <p>The API is reminiscent of the Comparable interface returning {@code -1} if * the element is before the range, {@code 0} if contained within the range and * {@code 1} if the element is after the range. </p> @@ -334,7 +334,7 @@ public final class Range<T> implements Serializable { /** * <p>Checks whether this range is overlapped by the specified range.</p> - * + * * <p>Two ranges overlap if there is at least one element in common.</p> * * <p>This method may fail if the ranges have two different comparators or element types.</p> @@ -451,13 +451,13 @@ public final class Range<T> implements Serializable { /** * <p>Formats the receiver using the given format.</p> - * + * * <p>This uses {@link java.util.Formattable} to perform the formatting. Three variables may * be used to embed the minimum, maximum and comparator. * Use {@code %1$s} for the minimum element, {@code %2$s} for the maximum element * and {@code %3$s} for the comparator. * The default format used by {@code toString()} is {@code [%1$s..%2$s]}.</p> - * + * * @param format the format string, optionally containing {@code %1$s}, {@code %2$s} and {@code %3$s}, not null * @return the formatted string, not null */ @@ -470,7 +470,7 @@ public final class Range<T> implements Serializable { private enum ComparableComparator implements Comparator { INSTANCE; /** - * Comparable based compare implementation. + * Comparable based compare implementation. * * @param obj1 left hand side of comparison * @param obj2 right hand side of comparison http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/SerializationException.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/SerializationException.java b/src/main/java/org/apache/commons/lang3/SerializationException.java index 588eff0..1d1d16a 100644 --- a/src/main/java/org/apache/commons/lang3/SerializationException.java +++ b/src/main/java/org/apache/commons/lang3/SerializationException.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. @@ -28,7 +28,7 @@ public class SerializationException extends RuntimeException { /** * Required for serialization support. - * + * * @see java.io.Serializable */ private static final long serialVersionUID = 4029025366392702726L; http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/SerializationUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/SerializationUtils.java b/src/main/java/org/apache/commons/lang3/SerializationUtils.java index 670ef18..5fca908 100644 --- a/src/main/java/org/apache/commons/lang3/SerializationUtils.java +++ b/src/main/java/org/apache/commons/lang3/SerializationUtils.java @@ -161,17 +161,17 @@ public class SerializationUtils { * <p> * Deserializes an {@code Object} from the specified stream. * </p> - * + * * <p> * The stream will be closed once the object is written. This avoids the need for a finally clause, and maybe also * exception handling, in the application code. * </p> - * + * * <p> * The stream passed in is not buffered internally within this method. This is the responsibility of your * application if desired. * </p> - * + * * <p> * If the call site incorrectly types the return value, a {@link ClassCastException} is thrown from the call site. * Without Generics in this declaration, the call site must type cast and can cause the same ClassCastException. @@ -202,13 +202,13 @@ public class SerializationUtils { * <p> * Deserializes a single {@code Object} from an array of bytes. * </p> - * + * * <p> * If the call site incorrectly types the return value, a {@link ClassCastException} is thrown from the call site. * Without Generics in this declaration, the call site must type cast and can cause the same ClassCastException. * Note that in both cases, the ClassCastException is in the call site, not in this method. * </p> - * + * * @param <T> the object type to be deserialized * @param objectData * the serialized object, must not be null @@ -232,12 +232,12 @@ public class SerializationUtils { * containers and application servers, no matter in which of the * <code>ClassLoader</code> the particular class that encapsulates * serialization/deserialization lives. </p> - * + * * <p>For more in-depth information about the problem for which this * class here is a workaround, see the JIRA issue LANG-626. </p> */ static class ClassLoaderAwareObjectInputStream extends ObjectInputStream { - private static final Map<String, Class<?>> primitiveTypes = + private static final Map<String, Class<?>> primitiveTypes = new HashMap<>(); static { @@ -253,7 +253,7 @@ public class SerializationUtils { } private final ClassLoader classLoader; - + /** * Constructor. * @param in The <code>InputStream</code>. http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java index df2a835..2d0a5db 100644 --- a/src/main/java/org/apache/commons/lang3/StringEscapeUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringEscapeUtils.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. @@ -46,45 +46,45 @@ public class StringEscapeUtils { /* ESCAPE TRANSLATORS */ /** - * Translator object for escaping Java. - * - * While {@link #escapeJava(String)} is the expected method of use, this - * object allows the Java escaping functionality to be used - * as the foundation for a custom translator. + * Translator object for escaping Java. + * + * While {@link #escapeJava(String)} is the expected method of use, this + * object allows the Java escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator ESCAPE_JAVA = + public static final CharSequenceTranslator ESCAPE_JAVA = new LookupTranslator( - new String[][] { + new String[][] { {"\"", "\\\""}, {"\\", "\\\\"}, }).with( new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE()) ).with( - JavaUnicodeEscaper.outsideOf(32, 0x7f) + JavaUnicodeEscaper.outsideOf(32, 0x7f) ); /** - * Translator object for escaping EcmaScript/JavaScript. - * - * While {@link #escapeEcmaScript(String)} is the expected method of use, this - * object allows the EcmaScript escaping functionality to be used - * as the foundation for a custom translator. + * Translator object for escaping EcmaScript/JavaScript. + * + * While {@link #escapeEcmaScript(String)} is the expected method of use, this + * object allows the EcmaScript escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator ESCAPE_ECMASCRIPT = + public static final CharSequenceTranslator ESCAPE_ECMASCRIPT = new AggregateTranslator( new LookupTranslator( - new String[][] { + new String[][] { {"'", "\\'"}, {"\"", "\\\""}, {"\\", "\\\\"}, {"/", "\\/"} }), new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE()), - JavaUnicodeEscaper.outsideOf(32, 0x7f) + JavaUnicodeEscaper.outsideOf(32, 0x7f) ); /** @@ -110,24 +110,24 @@ public class StringEscapeUtils { /** * Translator object for escaping XML. - * - * While {@link #escapeXml(String)} is the expected method of use, this - * object allows the XML escaping functionality to be used - * as the foundation for a custom translator. + * + * While {@link #escapeXml(String)} is the expected method of use, this + * object allows the XML escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 * @deprecated use {@link #ESCAPE_XML10} or {@link #ESCAPE_XML11} instead. */ @Deprecated - public static final CharSequenceTranslator ESCAPE_XML = + public static final CharSequenceTranslator ESCAPE_XML = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_ESCAPE()), new LookupTranslator(EntityArrays.APOS_ESCAPE()) ); - + /** * Translator object for escaping XML 1.0. - * + * * While {@link #escapeXml10(String)} is the expected method of use, this * object allows the XML escaping functionality to be used * as the foundation for a custom translator. @@ -176,10 +176,10 @@ public class StringEscapeUtils { NumericEntityEscaper.between(0x86, 0x9f), new UnicodeUnpairedSurrogateRemover() ); - + /** * Translator object for escaping XML 1.1. - * + * * While {@link #escapeXml11(String)} is the expected method of use, this * object allows the XML escaping functionality to be used * as the foundation for a custom translator. @@ -207,14 +207,14 @@ public class StringEscapeUtils { /** * Translator object for escaping HTML version 3.0. - * - * While {@link #escapeHtml3(String)} is the expected method of use, this - * object allows the HTML escaping functionality to be used - * as the foundation for a custom translator. + * + * While {@link #escapeHtml3(String)} is the expected method of use, this + * object allows the HTML escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator ESCAPE_HTML3 = + public static final CharSequenceTranslator ESCAPE_HTML3 = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_ESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE()) @@ -222,14 +222,14 @@ public class StringEscapeUtils { /** * Translator object for escaping HTML version 4.0. - * - * While {@link #escapeHtml4(String)} is the expected method of use, this - * object allows the HTML escaping functionality to be used - * as the foundation for a custom translator. + * + * While {@link #escapeHtml4(String)} is the expected method of use, this + * object allows the HTML escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator ESCAPE_HTML4 = + public static final CharSequenceTranslator ESCAPE_HTML4 = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_ESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE()), @@ -237,25 +237,25 @@ public class StringEscapeUtils { ); /** - * Translator object for escaping individual Comma Separated Values. - * - * While {@link #escapeCsv(String)} is the expected method of use, this - * object allows the CSV escaping functionality to be used - * as the foundation for a custom translator. + * Translator object for escaping individual Comma Separated Values. + * + * While {@link #escapeCsv(String)} is the expected method of use, this + * object allows the CSV escaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ public static final CharSequenceTranslator ESCAPE_CSV = new CsvEscaper(); // TODO: Create a parent class - 'SinglePassTranslator' ? - // It would handle the index checking + length returning, + // It would handle the index checking + length returning, // and could also have an optimization check method. static class CsvEscaper extends CharSequenceTranslator { private static final char CSV_DELIMITER = ','; private static final char CSV_QUOTE = '"'; private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE); - private static final char[] CSV_SEARCH_CHARS = + private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF}; @Override @@ -279,22 +279,22 @@ public class StringEscapeUtils { /* UNESCAPE TRANSLATORS */ /** - * Translator object for unescaping escaped Java. - * - * While {@link #unescapeJava(String)} is the expected method of use, this - * object allows the Java unescaping functionality to be used - * as the foundation for a custom translator. + * Translator object for unescaping escaped Java. + * + * While {@link #unescapeJava(String)} is the expected method of use, this + * object allows the Java unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ // TODO: throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)? - public static final CharSequenceTranslator UNESCAPE_JAVA = + public static final CharSequenceTranslator UNESCAPE_JAVA = new AggregateTranslator( new OctalUnescaper(), // .between('\1', '\377'), new UnicodeUnescaper(), new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_UNESCAPE()), new LookupTranslator( - new String[][] { + new String[][] { {"\\\\", "\\"}, {"\\\"", "\""}, {"\\'", "'"}, @@ -303,11 +303,11 @@ public class StringEscapeUtils { ); /** - * Translator object for unescaping escaped EcmaScript. - * - * While {@link #unescapeEcmaScript(String)} is the expected method of use, this - * object allows the EcmaScript unescaping functionality to be used - * as the foundation for a custom translator. + * Translator object for unescaping escaped EcmaScript. + * + * While {@link #unescapeEcmaScript(String)} is the expected method of use, this + * object allows the EcmaScript unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ @@ -325,15 +325,15 @@ public class StringEscapeUtils { public static final CharSequenceTranslator UNESCAPE_JSON = UNESCAPE_JAVA; /** - * Translator object for unescaping escaped HTML 3.0. - * - * While {@link #unescapeHtml3(String)} is the expected method of use, this - * object allows the HTML unescaping functionality to be used - * as the foundation for a custom translator. + * Translator object for unescaping escaped HTML 3.0. + * + * While {@link #unescapeHtml3(String)} is the expected method of use, this + * object allows the HTML unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator UNESCAPE_HTML3 = + public static final CharSequenceTranslator UNESCAPE_HTML3 = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_UNESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()), @@ -341,15 +341,15 @@ public class StringEscapeUtils { ); /** - * Translator object for unescaping escaped HTML 4.0. - * - * While {@link #unescapeHtml4(String)} is the expected method of use, this - * object allows the HTML unescaping functionality to be used - * as the foundation for a custom translator. + * Translator object for unescaping escaped HTML 4.0. + * + * While {@link #unescapeHtml4(String)} is the expected method of use, this + * object allows the HTML unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator UNESCAPE_HTML4 = + public static final CharSequenceTranslator UNESCAPE_HTML4 = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_UNESCAPE()), new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()), @@ -359,14 +359,14 @@ public class StringEscapeUtils { /** * Translator object for unescaping escaped XML. - * - * While {@link #unescapeXml(String)} is the expected method of use, this - * object allows the XML unescaping functionality to be used - * as the foundation for a custom translator. + * + * While {@link #unescapeXml(String)} is the expected method of use, this + * object allows the XML unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ - public static final CharSequenceTranslator UNESCAPE_XML = + public static final CharSequenceTranslator UNESCAPE_XML = new AggregateTranslator( new LookupTranslator(EntityArrays.BASIC_UNESCAPE()), new LookupTranslator(EntityArrays.APOS_UNESCAPE()), @@ -375,10 +375,10 @@ public class StringEscapeUtils { /** * Translator object for unescaping escaped Comma Separated Value entries. - * - * While {@link #unescapeCsv(String)} is the expected method of use, this - * object allows the CSV unescaping functionality to be used - * as the foundation for a custom translator. + * + * While {@link #unescapeCsv(String)} is the expected method of use, this + * object allows the CSV unescaping functionality to be used + * as the foundation for a custom translator. * * @since 3.0 */ @@ -389,7 +389,7 @@ public class StringEscapeUtils { private static final char CSV_DELIMITER = ','; private static final char CSV_QUOTE = '"'; private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE); - private static final char[] CSV_SEARCH_CHARS = + private static final char[] CSV_SEARCH_CHARS = new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF}; @Override @@ -520,7 +520,7 @@ public class StringEscapeUtils { * For example, it will turn a sequence of {@code '\'} and * {@code 'n'} into a newline character, unless the {@code '\'} * is preceded by another {@code '\'}.</p> - * + * * @param input the {@code String} to unescape, may be null * @return a new unescaped {@code String}, {@code null} if null string input */ @@ -569,7 +569,7 @@ public class StringEscapeUtils { * * <p> * For example: - * </p> + * </p> * <p><code>"bread" & "butter"</code></p> * becomes: * <p> @@ -582,13 +582,13 @@ public class StringEscapeUtils { * * @param input the {@code String} to escape, may be null * @return a new escaped {@code String}, {@code null} if null string input - * + * * @see <a href="http://hotwired.lycos.com/webmonkey/reference/special_characters/";>ISO Entities</a> * @see <a href="http://www.w3.org/TR/REC-html32#latin1";>HTML 3.2 Character Entities for ISO Latin-1</a> * @see <a href="http://www.w3.org/TR/REC-html40/sgml/entities.html";>HTML 4.0 Character entity references</a> * @see <a href="http://www.w3.org/TR/html401/charset.html#h-5.3";>HTML 4.01 Character References</a> * @see <a href="http://www.w3.org/TR/html401/charset.html#code-position";>HTML 4.01 Code positions</a> - * + * * @since 3.0 */ public static final String escapeHtml4(final String input) { @@ -601,7 +601,7 @@ public class StringEscapeUtils { * * @param input the {@code String} to escape, may be null * @return a new escaped {@code String}, {@code null} if null string input - * + * * @since 3.0 */ public static final String escapeHtml3(final String input) { @@ -623,7 +623,7 @@ public class StringEscapeUtils { * * @param input the {@code String} to unescape, may be null * @return a new unescaped {@code String}, {@code null} if null string input - * + * * @since 3.0 */ public static final String unescapeHtml4(final String input) { @@ -637,7 +637,7 @@ public class StringEscapeUtils { * * @param input the {@code String} to unescape, may be null * @return a new unescaped {@code String}, {@code null} if null string input - * + * * @since 3.0 */ public static final String unescapeHtml3(final String input) { @@ -655,9 +655,9 @@ public class StringEscapeUtils { * <p>Supports only the five basic XML entities (gt, lt, quot, amp, apos). * Does not support DTDs or external entities.</p> * - * <p>Note that Unicode characters greater than 0x7f are as of 3.0, no longer - * escaped. If you still wish this functionality, you can achieve it - * via the following: + * <p>Note that Unicode characters greater than 0x7f are as of 3.0, no longer + * escaped. If you still wish this functionality, you can achieve it + * via the following: * {@code StringEscapeUtils.ESCAPE_XML.with( NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE) );}</p> * * @param input the {@code String} to escape, may be null @@ -681,14 +681,14 @@ public class StringEscapeUtils { * characters or unpaired Unicode surrogate codepoints, even after escaping. * {@code escapeXml10} will remove characters that do not fit in the * following ranges:</p> - * + * * <p>{@code #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]}</p> - * + * * <p>Though not strictly necessary, {@code escapeXml10} will escape * characters in the following ranges:</p> - * + * * <p>{@code [#x7F-#x84] | [#x86-#x9F]}</p> - * + * * <p>The returned string can be inserted into a valid XML 1.0 or XML 1.1 * document. If you want to allow more non-text characters in an XML 1.1 * document, use {@link #escapeXml11(String)}.</p> @@ -701,7 +701,7 @@ public class StringEscapeUtils { public static String escapeXml10(final String input) { return ESCAPE_XML10.translate(input); } - + /** * <p>Escapes the characters in a {@code String} using XML entities.</p> * @@ -713,13 +713,13 @@ public class StringEscapeUtils { * the null byte or unpaired Unicode surrogate codepoints, even after escaping. * {@code escapeXml11} will remove characters that do not fit in the following * ranges:</p> - * + * * <p>{@code [#x1-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]}</p> - * + * * <p>{@code escapeXml11} will escape characters in the following ranges:</p> - * + * * <p>{@code [#x1-#x8] | [#xB-#xC] | [#xE-#x1F] | [#x7F-#x84] | [#x86-#x9F]}</p> - * + * * <p>The returned string can be inserted into a valid XML 1.1 document. Do not * use it for XML 1.0 documents.</p> * @@ -741,7 +741,7 @@ public class StringEscapeUtils { * <p>Supports only the five basic XML entities (gt, lt, quot, amp, apos). * Does not support DTDs or external entities.</p> * - * <p>Note that numerical \\u Unicode codes are unescaped to their respective + * <p>Note that numerical \\u Unicode codes are unescaped to their respective * Unicode characters. This may change in future releases. </p> * * @param input the {@code String} to unescape, may be null @@ -783,21 +783,21 @@ public class StringEscapeUtils { /** * <p>Returns a {@code String} value for an unescaped CSV column. </p> * - * <p>If the value is enclosed in double quotes, and contains a comma, newline - * or double quote, then quotes are removed. + * <p>If the value is enclosed in double quotes, and contains a comma, newline + * or double quote, then quotes are removed. * </p> * - * <p>Any double quote escaped characters (a pair of double quotes) are unescaped + * <p>Any double quote escaped characters (a pair of double quotes) are unescaped * to just one double quote. </p> * - * <p>If the value is not enclosed in double quotes, or is and does not contain a + * <p>If the value is not enclosed in double quotes, or is and does not contain a * comma, newline or double quote, then the String value is returned unchanged.</p> * * see <a href="http://en.wikipedia.org/wiki/Comma-separated_values";>Wikipedia</a> and * <a href="http://tools.ietf.org/html/rfc4180";>RFC 4180</a>. * * @param input the input CSV column String, may be null - * @return the input String, with enclosing double quotes removed and embedded double + * @return the input String, with enclosing double quotes removed and embedded double * quotes unescaped, {@code null} if null string input * @since 2.4 */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/StringUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/StringUtils.java b/src/main/java/org/apache/commons/lang3/StringUtils.java index 7f64322..442e285 100644 --- a/src/main/java/org/apache/commons/lang3/StringUtils.java +++ b/src/main/java/org/apache/commons/lang3/StringUtils.java @@ -228,7 +228,7 @@ public class StringUtils { public static boolean isNotEmpty(final CharSequence cs) { return !isEmpty(cs); } - + /** * <p>Checks if any of the CharSequences are empty ("") or null.</p> * @@ -316,7 +316,7 @@ public class StringUtils { /** * <p>Checks if a CharSequence is empty (""), null or whitespace only.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <pre> @@ -347,7 +347,7 @@ public class StringUtils { /** * <p>Checks if a CharSequence is not empty (""), not null and not whitespace only.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <pre> @@ -370,7 +370,7 @@ public class StringUtils { /** * <p>Checks if any of the CharSequences are empty ("") or null or whitespace only.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <pre> @@ -404,7 +404,7 @@ public class StringUtils { /** * <p>Checks if none of the CharSequences are empty (""), null or whitespace only.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <pre> @@ -450,7 +450,7 @@ public class StringUtils { * @since 3.6 */ public static boolean isAllBlank(final CharSequence... css) { - if (ArrayUtils.isEmpty(css)) { + if (ArrayUtils.isEmpty(css)) { return true; } for (final CharSequence cs : css) { @@ -774,7 +774,7 @@ public class StringUtils { str = stripStart(str, stripChars); return stripEnd(str, stripChars); } - + /** * <p>Strips any of a set of characters from the start of a String.</p> * @@ -2019,9 +2019,9 @@ public class StringUtils { /** * <p>Check whether the given CharSequence contains any whitespace characters.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> - * + * * @param seq the CharSequence to check (may be {@code null}) * @return {@code true} if the CharSequence is not empty and * contains at least 1 (breaking) whitespace character @@ -2235,7 +2235,7 @@ public class StringUtils { * StringUtils.containsAny("abc", "d", "abc") = true * </pre> * - * + * * @param cs The CharSequence to check, may be null * @param searchCharSequences The array of CharSequences to search for, may be null. * Individual CharSequences may be null as well. @@ -5468,7 +5468,7 @@ public class StringUtils { /** * <p>Replaces a String with another String inside a larger String, - * for the first {@code max} values of the search String, + * for the first {@code max} values of the search String, * case sensitively/insensisitively based on {@code ignoreCase} value.</p> * * <p>A {@code null} reference passed to this method is a no-op.</p> @@ -7200,7 +7200,7 @@ public class StringUtils { /** * <p>Checks if the CharSequence contains only whitespace.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <p>{@code null} will return {@code false}. @@ -7390,7 +7390,7 @@ public class StringUtils { /** * <p>Returns either the passed in CharSequence, or if the CharSequence is * whitespace, empty ("") or {@code null}, the value of {@code defaultStr}.</p> - * + * * <p>Whitespace is defined by {@link Character#isWhitespace(char)}.</p> * * <pre> @@ -7539,7 +7539,7 @@ public class StringUtils { * * <p>Specifically:</p> * <ul> - * <li>If the number of characters in {@code str} is less than or equal to + * <li>If the number of characters in {@code str} is less than or equal to * {@code maxWidth}, return {@code str}.</li> * <li>Else abbreviate it to {@code (substring(str, 0, max-3) + "...")}.</li> * <li>If {@code maxWidth} is less than {@code 4}, throw an @@ -7616,7 +7616,7 @@ public class StringUtils { * * <p>Specifically:</p> * <ul> - * <li>If the number of characters in {@code str} is less than or equal to + * <li>If the number of characters in {@code str} is less than or equal to * {@code maxWidth}, return {@code str}.</li> * <li>Else abbreviate it to {@code (substring(str, 0, max-abbrevMarker.length) + abbrevMarker)}.</li> * <li>If {@code maxWidth} is less than {@code abbrevMarker.length + 1}, throw an @@ -8009,7 +8009,7 @@ public class StringUtils { * another, where each change is a single character modification (deletion, * insertion or substitution).</p> * - * <p>The implementation uses a single-dimensional array of length s.length() + 1. See + * <p>The implementation uses a single-dimensional array of length s.length() + 1. See * <a href="http://blog.softwx.net/2014/12/optimizing-levenshtein-algorithm-in-c.html";> * http://blog.softwx.net/2014/12/optimizing-levenshtein-algorithm-in-c.html</a> for details.</p> * @@ -8260,16 +8260,16 @@ public class StringUtils { } return -1; } - + /** * <p>Find the Jaro Winkler Distance which indicates the similarity score between two Strings.</p> * - * <p>The Jaro measure is the weighted sum of percentage of matched characters from each file and transposed characters. + * <p>The Jaro measure is the weighted sum of percentage of matched characters from each file and transposed characters. * Winkler increased this measure for matching initial characters.</p> * * <p>This implementation is based on the Jaro Winkler similarity algorithm * from <a href="http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance";>http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance</a>.</p> - * + * * <pre> * StringUtils.getJaroWinklerDistance(null, null) = IllegalArgumentException * StringUtils.getJaroWinklerDistance("","") = 0.0 @@ -8972,7 +8972,7 @@ public class StringUtils { /** * Converts a <code>byte[]</code> to a String using the specified character encoding. - * + * * @param bytes * the byte array to read from * @param charset @@ -8991,7 +8991,7 @@ public class StringUtils { * <p> * Wraps a string with a char. * </p> - * + * * <pre> * StringUtils.wrap(null, *) = null * StringUtils.wrap("", *) = "" @@ -9000,7 +9000,7 @@ public class StringUtils { * StringUtils.wrap("ab", '\'') = "'ab'" * StringUtils.wrap("\"ab\"", '\"') = "\"\"ab\"\"" * </pre> - * + * * @param str * the string to be wrapped, may be {@code null} * @param wrapWith @@ -9021,11 +9021,11 @@ public class StringUtils { * <p> * Wraps a String with another String. * </p> - * + * * <p> * A {@code null} input String returns {@code null}. * </p> - * + * * <pre> * StringUtils.wrap(null, *) = null * StringUtils.wrap("", *) = "" @@ -9038,7 +9038,7 @@ public class StringUtils { * StringUtils.wrap("\"abcd\"", "'") = "'\"abcd\"'" * StringUtils.wrap("'abcd'", "\"") = "\"'abcd'\"" * </pre> - * + * * @param str * the String to be wrapper, may be null * @param wrapWith @@ -9059,7 +9059,7 @@ public class StringUtils { * <p> * Wraps a string with a char if that char is missing from the start or end of the given string. * </p> - * + * * <pre> * StringUtils.wrap(null, *) = null * StringUtils.wrap("", *) = "" @@ -9072,7 +9072,7 @@ public class StringUtils { * StringUtils.wrap("/a/b/c", '/') = "/a/b/c/" * StringUtils.wrap("a/b/c/", '/') = "/a/b/c/" * </pre> - * + * * @param str * the string to be wrapped, may be {@code null} * @param wrapWith @@ -9099,7 +9099,7 @@ public class StringUtils { * <p> * Wraps a string with a string if that string is missing from the start or end of the given string. * </p> - * + * * <pre> * StringUtils.wrap(null, *) = null * StringUtils.wrap("", *) = "" @@ -9116,7 +9116,7 @@ public class StringUtils { * StringUtils.wrap("/a/b/c", "/") = "/a/b/c/" * StringUtils.wrap("a/b/c/", "/") = "/a/b/c/" * </pre> - * + * * @param str * the string to be wrapped, may be {@code null} * @param wrapWith @@ -9160,7 +9160,7 @@ public class StringUtils { * the String to be unwrapped, can be null * @param wrapToken * the String used to unwrap - * @return unwrapped String or the original string + * @return unwrapped String or the original string * if it is not quoted properly with the wrapToken * @since 3.6 */ @@ -9185,7 +9185,7 @@ public class StringUtils { * <p> * Unwraps a given string from a character. * </p> - * + * * <pre> * StringUtils.unwrap(null, null) = null * StringUtils.unwrap(null, '\0') = null @@ -9201,7 +9201,7 @@ public class StringUtils { * the String to be unwrapped, can be null * @param wrapChar * the character used to unwrap - * @return unwrapped String or the original string + * @return unwrapped String or the original string * if it is not quoted properly with the wrapChar * @since 3.6 */ @@ -9223,16 +9223,16 @@ public class StringUtils { /** * <p>Converts a {@code CharSequence} into an array of code points.</p> - * + * * <p>Valid pairs of surrogate code units will be converted into a single supplementary * code point. Isolated surrogate code units (i.e. a high surrogate not followed by a low surrogate or * a low surrogate not preceeded by a high surrogate) will be returned as-is.</p> - * + * * <pre> * StringUtils.toCodePoints(null) = null * StringUtils.toCodePoints("") = [] // empty array * </pre> - * + * * @param str the character sequence to convert * @return an array of code points * @since 3.6 http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/SystemUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/SystemUtils.java b/src/main/java/org/apache/commons/lang3/SystemUtils.java index f553618..50d260b 100644 --- a/src/main/java/org/apache/commons/lang3/SystemUtils.java +++ b/src/main/java/org/apache/commons/lang3/SystemUtils.java @@ -955,7 +955,7 @@ public class SystemUtils { * </p> * * @since 3.4 - * + * * @deprecated As of release 3.5, replaced by {@link #IS_JAVA_9} */ @Deprecated @@ -1497,11 +1497,11 @@ public class SystemUtils { /** * Gets the host name from an environment variable. - * + * * <p> * If you want to know what the network stack says is the host name, you should use {@code InetAddress.getLocalHost().getHostName()}. * </p> - * + * * @return the host name. * @since 3.6 */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/arch/Processor.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/arch/Processor.java b/src/main/java/org/apache/commons/lang3/arch/Processor.java index 9f6b3db..cca224d 100644 --- a/src/main/java/org/apache/commons/lang3/arch/Processor.java +++ b/src/main/java/org/apache/commons/lang3/arch/Processor.java @@ -35,17 +35,17 @@ public class Processor { * </ul> */ public enum Arch { - + /** * A 32-bit processor architecture. */ - BIT_32, - + BIT_32, + /** * A 64-bit processor architecture. */ - BIT_64, - + BIT_64, + /** * An unknown-bit processor architecture. */ @@ -63,22 +63,22 @@ public class Processor { * </ul> */ public enum Type { - + /** * Intel x86 series of instruction set architectures. */ - X86, - + X86, + /** * Intel Itanium 64-bit architecture. */ - IA_64, - + IA_64, + /** * AppleâIBMâMotorola PowerPC architecture. */ - PPC, - + PPC, + /** * Unknown architecture. */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/Builder.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/Builder.java b/src/main/java/org/apache/commons/lang3/builder/Builder.java index 496d224..3e69afb 100644 --- a/src/main/java/org/apache/commons/lang3/builder/Builder.java +++ b/src/main/java/org/apache/commons/lang3/builder/Builder.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. @@ -18,52 +18,52 @@ package org.apache.commons.lang3.builder; /** * <p> - * The Builder interface is designed to designate a class as a <em>builder</em> - * object in the Builder design pattern. Builders are capable of creating and - * configuring objects or results that normally take multiple steps to construct - * or are very complex to derive. + * The Builder interface is designed to designate a class as a <em>builder</em> + * object in the Builder design pattern. Builders are capable of creating and + * configuring objects or results that normally take multiple steps to construct + * or are very complex to derive. * </p> - * + * * <p> - * The builder interface defines a single method, {@link #build()}, that - * classes must implement. The result of this method should be the final + * The builder interface defines a single method, {@link #build()}, that + * classes must implement. The result of this method should be the final * configured object or result after all building operations are performed. * </p> - * + * * <p> - * It is a recommended practice that the methods supplied to configure the + * It is a recommended practice that the methods supplied to configure the * object or result being built return a reference to {@code this} so that * method calls can be chained together. * </p> - * + * * <p> * Example Builder: * <pre><code> * class FontBuilder implements Builder<Font> { * private Font font; - * + * * public FontBuilder(String fontName) { * this.font = new Font(fontName, Font.PLAIN, 12); * } - * + * * public FontBuilder bold() { * this.font = this.font.deriveFont(Font.BOLD); * return this; // Reference returned so calls can be chained * } - * + * * public FontBuilder size(float pointSize) { * this.font = this.font.deriveFont(pointSize); * return this; // Reference returned so calls can be chained * } - * + * * // Other Font construction methods - * + * * public Font build() { * return this.font; * } * } * </code></pre> - * + * * Example Builder Usage: * <pre><code> * Font bold14ptSansSerifFont = new FontBuilder(Font.SANS_SERIF).bold() @@ -71,17 +71,17 @@ package org.apache.commons.lang3.builder; * .build(); * </code></pre> * - * + * * @param <T> the type of object that the builder will construct or compute. - * + * * @since 3.0 */ public interface Builder<T> { /** - * Returns a reference to the object being constructed or result being + * Returns a reference to the object being constructed or result being * calculated by the builder. - * + * * @return the object constructed or result calculated by the builder. */ T build(); http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java index 875b088..4a0a1d1 100644 --- a/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/CompareToBuilder.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,7 +24,7 @@ import java.util.Comparator; import org.apache.commons.lang3.ArrayUtils; -/** +/** * Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods. * * <p>It is consistent with <code>equals(Object)</code> and @@ -60,7 +60,7 @@ import org.apache.commons.lang3.ArrayUtils; * } * } * </pre> - * + * * <p>Values are compared in the order they are appended to the builder. If any comparison returns * a non-zero result, then that value will be the result returned by {@code toComparison()} and all * subsequent comparisons are skipped.</p> @@ -80,8 +80,8 @@ import org.apache.commons.lang3.ArrayUtils; * return CompareToBuilder.reflectionCompare(this, o); * } * </pre> - * - * <p>The reflective methods compare object fields in the order returned by + * + * <p>The reflective methods compare object fields in the order returned by * {@link Class#getDeclaredFields()}. The fields of the class are compared first, followed by those * of its parent classes (in order from the bottom to the top of the class hierarchy).</p> * @@ -93,7 +93,7 @@ import org.apache.commons.lang3.ArrayUtils; * @since 1.0 */ public class CompareToBuilder implements Builder<Integer> { - + /** * Current state of the comparison as appended fields are checked. */ @@ -102,8 +102,8 @@ public class CompareToBuilder implements Builder<Integer> { /** * <p>Constructor for CompareToBuilder.</p> * - * <p>Starts off assuming that the objects are equal. Multiple calls are - * then made to the various append methods, followed by a call to + * <p>Starts off assuming that the objects are equal. Multiple calls are + * then made to the various append methods, followed by a call to * {@link #toComparison} to get the result.</p> */ public CompareToBuilder() { @@ -112,11 +112,11 @@ public class CompareToBuilder implements Builder<Integer> { } //----------------------------------------------------------------------- - /** + /** * <p>Compares two <code>Object</code>s via reflection.</p> * * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code> - * is used to bypass normal access control checks. This will fail under a + * is used to bypass normal access control checks. This will fail under a * security manager unless the appropriate permissions are set.</p> * * <ul> @@ -146,7 +146,7 @@ public class CompareToBuilder implements Builder<Integer> { * <p>Compares two <code>Object</code>s via reflection.</p> * * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code> - * is used to bypass normal access control checks. This will fail under a + * is used to bypass normal access control checks. This will fail under a * security manager unless the appropriate permissions are set.</p> * * <ul> @@ -178,7 +178,7 @@ public class CompareToBuilder implements Builder<Integer> { * <p>Compares two <code>Object</code>s via reflection.</p> * * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code> - * is used to bypass normal access control checks. This will fail under a + * is used to bypass normal access control checks. This will fail under a * security manager unless the appropriate permissions are set.</p> * * <ul> @@ -211,7 +211,7 @@ public class CompareToBuilder implements Builder<Integer> { * <p>Compares two <code>Object</code>s via reflection.</p> * * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code> - * is used to bypass normal access control checks. This will fail under a + * is used to bypass normal access control checks. This will fail under a * security manager unless the appropriate permissions are set.</p> * * <ul> @@ -244,7 +244,7 @@ public class CompareToBuilder implements Builder<Integer> { * <p>Compares two <code>Object</code>s via reflection.</p> * * <p>Fields can be private, thus <code>AccessibleObject.setAccessible</code> - * is used to bypass normal access control checks. This will fail under a + * is used to bypass normal access control checks. This will fail under a * security manager unless the appropriate permissions are set.</p> * * <ul> @@ -273,10 +273,10 @@ public class CompareToBuilder implements Builder<Integer> { * @since 2.2 (2.0 as <code>reflectionCompare(Object, Object, boolean, Class)</code>) */ public static int reflectionCompare( - final Object lhs, - final Object rhs, - final boolean compareTransients, - final Class<?> reflectUpToClass, + final Object lhs, + final Object rhs, + final boolean compareTransients, + final Class<?> reflectUpToClass, final String... excludeFields) { if (lhs == rhs) { @@ -301,7 +301,7 @@ public class CompareToBuilder implements Builder<Integer> { /** * <p>Appends to <code>builder</code> the comparison of <code>lhs</code> * to <code>rhs</code> using the fields defined in <code>clazz</code>.</p> - * + * * @param lhs left-hand object * @param rhs right-hand object * @param clazz <code>Class</code> that defines fields to be compared @@ -316,7 +316,7 @@ public class CompareToBuilder implements Builder<Integer> { final CompareToBuilder builder, final boolean useTransients, final String[] excludeFields) { - + final Field[] fields = clazz.getDeclaredFields(); AccessibleObject.setAccessible(fields, true); for (int i = 0; i < fields.length && builder.comparison == 0; i++) { @@ -352,7 +352,7 @@ public class CompareToBuilder implements Builder<Integer> { comparison = superCompareTo; return this; } - + //----------------------------------------------------------------------- /** * <p>Appends to the <code>builder</code> the comparison of @@ -364,7 +364,7 @@ public class CompareToBuilder implements Builder<Integer> { * a <code>null</code> object is less than a non-<code>null</code> object</li> * <li>Check the object contents</li> * </ol> - * + * * <p><code>lhs</code> must either be an array or implement {@link Comparable}.</p> * * @param lhs left-hand object @@ -498,7 +498,7 @@ public class CompareToBuilder implements Builder<Integer> { /** * Appends to the <code>builder</code> the comparison of * two <code>short</code>s. - * + * * @param lhs left-hand value * @param rhs right-hand value * @return this - used to chain append calls @@ -530,7 +530,7 @@ public class CompareToBuilder implements Builder<Integer> { /** * Appends to the <code>builder</code> the comparison of * two <code>byte</code>s. - * + * * @param lhs left-hand value * @param rhs right-hand value * @return this - used to chain append calls @@ -632,7 +632,7 @@ public class CompareToBuilder implements Builder<Integer> { public CompareToBuilder append(final Object[] lhs, final Object[] rhs) { return append(lhs, rhs, null); } - + /** * <p>Appends to the <code>builder</code> the deep comparison of * two <code>Object</code> arrays.</p> @@ -1007,7 +1007,7 @@ public class CompareToBuilder implements Builder<Integer> { * the <code>builder</code> has judged the "left-hand" side * as less than, greater than, or equal to the "right-hand" * side. - * + * * @return final comparison result * @see #build() */ @@ -1020,7 +1020,7 @@ public class CompareToBuilder implements Builder<Integer> { * the <code>builder</code> has judged the "left-hand" side * as less than, greater than, or equal to the "right-hand" * side. - * + * * @return final comparison result as an Integer * @see #toComparison() * @since 3.0 http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/Diff.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/Diff.java b/src/main/java/org/apache/commons/lang3/builder/Diff.java index d1b0daf..aee0d24 100644 --- a/src/main/java/org/apache/commons/lang3/builder/Diff.java +++ b/src/main/java/org/apache/commons/lang3/builder/Diff.java @@ -27,13 +27,13 @@ import org.apache.commons.lang3.tuple.Pair; * A {@code Diff} contains the differences between two {@link Diffable} class * fields. * </p> - * + * * <p> * Typically, {@code Diff}s are retrieved by using a {@link DiffBuilder} to * produce a {@link DiffResult}, containing the differences between two objects. * </p> - * - * + * + * * @param <T> * The type of object contained within this {@code Diff}. Differences * between primitive objects are stored as their Object wrapper @@ -51,7 +51,7 @@ public abstract class Diff<T> extends Pair<T, T> { * <p> * Constructs a new {@code Diff} for the given field name. * </p> - * + * * @param fieldName * the name of the field */ @@ -66,7 +66,7 @@ public abstract class Diff<T> extends Pair<T, T> { * <p> * Returns the type of the field. * </p> - * + * * @return the field type */ public final Type getType() { @@ -77,7 +77,7 @@ public abstract class Diff<T> extends Pair<T, T> { * <p> * Returns the name of the field. * </p> - * + * * @return the field name */ public final String getFieldName() { @@ -88,12 +88,12 @@ public abstract class Diff<T> extends Pair<T, T> { * <p> * Returns a {@code String} representation of the {@code Diff}, with the * following format:</p> - * + * * <pre> * [fieldname: left-value, right-value] * </pre> - * - * + * + * * @return the string representation */ @Override @@ -105,7 +105,7 @@ public abstract class Diff<T> extends Pair<T, T> { * <p> * Throws {@code UnsupportedOperationException}. * </p> - * + * * @param value * ignored * @return nothing http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java index ed2cfe9..3645ffc 100644 --- a/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java +++ b/src/main/java/org/apache/commons/lang3/builder/DiffBuilder.java @@ -27,19 +27,19 @@ import org.apache.commons.lang3.Validate; * <p> * Assists in implementing {@link Diffable#diff(Object)} methods. * </p> - * + * * <p> * To use this class, write code as follows: * </p> - * + * * <pre> * public class Person implements Diffable<Person> { * String name; * int age; * boolean smoker; - * + * * ... - * + * * public DiffResult diff(Person obj) { * // No need for null check, as NullPointerException correct if obj is null * return new DiffBuilder(this, obj, ToStringStyle.SHORT_PREFIX_STYLE) @@ -50,14 +50,14 @@ import org.apache.commons.lang3.Validate; * } * } * </pre> - * + * * <p> * The {@code ToStringStyle} passed to the constructor is embedded in the * returned {@code DiffResult} and influences the style of the * {@code DiffResult.toString()} method. This style choice can be overridden by * calling {@link DiffResult#toString(ToStringStyle)}. * </p> - * + * * @since 3.3 * @see Diffable * @see Diff @@ -76,13 +76,13 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Constructs a builder for the specified objects with the specified style. * </p> - * + * * <p> * If {@code lhs == rhs} or {@code lhs.equals(rhs)} then the builder will * not evaluate any calls to {@code append(...)} and will return an empty * {@link DiffResult} when {@link #build()} is executed. * </p> - * + * * @param lhs * {@code this} object * @param rhs @@ -119,13 +119,13 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Constructs a builder for the specified objects with the specified style. * </p> - * + * * <p> * If {@code lhs == rhs} or {@code lhs.equals(rhs)} then the builder will * not evaluate any calls to {@code append(...)} and will return an empty * {@link DiffResult} when {@link #build()} is executed. * </p> - * + * * <p> * This delegates to {@link #DiffBuilder(Object, Object, ToStringStyle, boolean)} * with the testTriviallyEqual flag enabled. @@ -151,7 +151,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code boolean}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -191,7 +191,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code boolean[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -230,7 +230,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code byte}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -269,7 +269,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code byte[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -309,7 +309,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code char}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -349,7 +349,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code char[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -389,7 +389,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code double}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -429,7 +429,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code double[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -469,7 +469,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code float}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -509,7 +509,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code float[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -549,7 +549,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code int}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -589,7 +589,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code int[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -629,7 +629,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code long}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -669,7 +669,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code long[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -709,7 +709,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code short}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -749,7 +749,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code short[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -789,7 +789,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code Objects}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -873,7 +873,7 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Test if two {@code Object[]}s are equal. * </p> - * + * * @param fieldName * the field name * @param lhs @@ -914,20 +914,20 @@ public class DiffBuilder implements Builder<DiffResult> { * <p> * Append diffs from another {@code DiffResult}. * </p> - * + * * <p> * This method is useful if you want to compare properties which are * themselves Diffable and would like to know which specific part of * it is different. * </p> - * + * * <pre> * public class Person implements Diffable<Person> { * String name; * Address address; // implements Diffable<Address> - * + * * ... - * + * * public DiffResult diff(Person obj) { * return new DiffBuilder(this, obj, ToStringStyle.SHORT_PREFIX_STYLE) * .append("name", this.name, obj.name) @@ -936,7 +936,7 @@ public class DiffBuilder implements Builder<DiffResult> { * } * } * </pre> - * + * * @param fieldName * the field name * @param diffResult @@ -967,7 +967,7 @@ public class DiffBuilder implements Builder<DiffResult> { * Builds a {@link DiffResult} based on the differences appended to this * builder. * </p> - * + * * @return a {@code DiffResult} containing the differences between the two * objects. */ http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/DiffResult.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java index 4bcba6b..d8fa976 100644 --- a/src/main/java/org/apache/commons/lang3/builder/DiffResult.java +++ b/src/main/java/org/apache/commons/lang3/builder/DiffResult.java @@ -32,7 +32,7 @@ import org.apache.commons.lang3.Validate; * <p> * Use a {@link DiffBuilder} to build a {@code DiffResult} comparing two objects. * </p> - * + * * @since 3.3 */ public class DiffResult implements Iterable<Diff<?>> { @@ -57,7 +57,7 @@ public class DiffResult implements Iterable<Diff<?>> { * Creates a {@link DiffResult} containing the differences between two * objects. * </p> - * + * * @param lhs * the left hand object * @param rhs @@ -93,7 +93,7 @@ public class DiffResult implements Iterable<Diff<?>> { * Returns an unmodifiable list of {@code Diff}s. The list may be empty if * there were no differences between the objects. * </p> - * + * * @return an unmodifiable list of {@code Diff}s */ public List<Diff<?>> getDiffs() { @@ -104,7 +104,7 @@ public class DiffResult implements Iterable<Diff<?>> { * <p> * Returns the number of differences between the two objects. * </p> - * + * * @return the number of differences */ public int getNumberOfDiffs() { @@ -115,7 +115,7 @@ public class DiffResult implements Iterable<Diff<?>> { * <p> * Returns the style used by the {@link #toString()} method. * </p> - * + * * @return the style */ public ToStringStyle getToStringStyle() { @@ -129,28 +129,28 @@ public class DiffResult implements Iterable<Diff<?>> { * and the style of the output is governed by the {@code ToStringStyle} * passed to the constructor. * </p> - * + * * <p> * If there are no differences stored in this list, the method will return * {@link #OBJECTS_SAME_STRING}. Otherwise, using the example given in * {@link Diffable} and {@link ToStringStyle#SHORT_PREFIX_STYLE}, an output * might be: * </p> - * + * * <pre> * Person[name=John Doe,age=32] differs from Person[name=Joe Bloggs,age=26] * </pre> - * + * * <p> * This indicates that the objects differ in name and age, but not in * smoking status. * </p> - * + * * <p> * To use a different {@code ToStringStyle} for an instance of this class, * use {@link #toString(ToStringStyle)}. * </p> - * + * * @return a {@code String} description of the differences. */ @Override @@ -163,10 +163,10 @@ public class DiffResult implements Iterable<Diff<?>> { * Builds a {@code String} description of the differences contained within * this {@code DiffResult}, using the supplied {@code ToStringStyle}. * </p> - * + * * @param style * the {@code ToStringStyle} to use when outputting the objects - * + * * @return a {@code String} description of the differences. */ public String toString(final ToStringStyle style) { @@ -190,7 +190,7 @@ public class DiffResult implements Iterable<Diff<?>> { * <p> * Returns an iterator over the {@code Diff} objects contained in this list. * </p> - * + * * @return the iterator */ @Override http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1da8ccdb/src/main/java/org/apache/commons/lang3/builder/Diffable.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/lang3/builder/Diffable.java b/src/main/java/org/apache/commons/lang3/builder/Diffable.java index 9f85eb1..12bc07d 100644 --- a/src/main/java/org/apache/commons/lang3/builder/Diffable.java +++ b/src/main/java/org/apache/commons/lang3/builder/Diffable.java @@ -20,13 +20,13 @@ package org.apache.commons.lang3.builder; * <p>{@code Diffable} classes can be compared with other objects * for differences. The {@link DiffResult} object retrieved can be queried * for a list of differences or printed using the {@link DiffResult#toString()}.</p> - * + * * <p>The calculation of the differences is <i>consistent with equals</i> if * and only if {@code d1.equals(d2)} implies {@code d1.diff(d2) == ""}. * It is strongly recommended that implementations are consistent with equals * to avoid confusion. Note that {@code null} is not an instance of any class * and {@code d1.diff(null)} should throw a {@code NullPointerException}.</p> - * + * * <p> * {@code Diffable} classes lend themselves well to unit testing, in which a * easily readable description of the differences between an anticipated result and @@ -44,7 +44,7 @@ public interface Diffable<T> { /** * <p>Retrieves a list of the differences between * this object and the supplied object.</p> - * + * * @param obj the object to diff against, can be {@code null} * @return a list of differences * @throws NullPointerException if the specified object is {@code null}
