Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Locales.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -159,7 +159,7 @@ public final class Locales extends Stati * ({@link #SIS}). In the later case, this method returns only the languages for which * localized resources are provided in the {@code org.apache.sis.util.resources} package. * - * @return The list of supported languages. + * @return the list of supported languages. */ public Locale[] getAvailableLanguages() { if (this == ALL) { @@ -176,7 +176,7 @@ public final class Locales extends Stati * ({@link #SIS}). In the later case, this method returns only the locales for which * localized resources are provided in the {@code org.apache.sis.util.resources} package. * - * @return The list of supported locales. + * @return the list of supported locales. */ public Locale[] getAvailableLocales() { if (this == ALL) { @@ -207,8 +207,8 @@ filter: for (final Locale locale : local * The instances returned by this method have no {@linkplain Locale#getCountry() country} * and no {@linkplain Locale#getVariant() variant} information. * - * @param locales The locales from which to get the languages. - * @return The languages, without country or variant information. + * @param locales the locales from which to get the languages. + * @return the languages, without country or variant information. */ private static Locale[] getLanguages(final Locale... locales) { final Set<String> codes = new LinkedHashSet<>(hashMapCapacity(locales.length)); @@ -232,9 +232,9 @@ filter: for (final Locale locale : local * and country codes use 2 or 3 letters. This method tries to convert 3-letters codes to 2-letters code on a * <cite>best effort</cite> basis.</p> * - * @param code The language code, optionally followed by country code and variant. - * @return The language for the given code (never {@code null}). - * @throws IllformedLocaleException If the given code is not valid. + * @param code the language code, optionally followed by country code and variant. + * @return the language for the given code (never {@code null}). + * @throws IllformedLocaleException if the given code is not valid. * * @see Locale#forLanguageTag(String) */ @@ -253,10 +253,10 @@ filter: for (final Locale locale : local * For example a dictionary may define the {@code "remarks"} property by values associated to the * {@code "remarks_en"} and {@code "remarks_fr"} keys, for English and French locales respectively.</div> * - * @param code The language code, which may be followed by country code. - * @param fromIndex Index of the first character to parse. - * @return The language for the given code (never {@code null}). - * @throws IllformedLocaleException If the given code is not valid. + * @param code the language code, which may be followed by country code. + * @param fromIndex index of the first character to parse. + * @return the language for the given code (never {@code null}). + * @throws IllformedLocaleException if the given code is not valid. * * @see Locale#forLanguageTag(String) * @see org.apache.sis.util.iso.Types#toInternationalString(Map, String) @@ -301,9 +301,9 @@ filter: for (final Locale locale : local * Converts a 3-letters ISO code to a 2-letters one. * If the given code is not recognized, then this method returns {@code code} unmodified. * - * @param code The 3-letters code. - * @param type Either {@link #LANGUAGE} or {@link #COUNTRY}. - * @return The 2-letters code, or {@code null} if none. + * @param code the 3-letters code. + * @param type either {@link #LANGUAGE} or {@link #COUNTRY}. + * @return the 2-letters code, or {@code null} if none. */ private static String toISO2(final String code, final short type) { final short alpha3 = toNumber(code, type); @@ -330,9 +330,9 @@ filter: for (final Locale locale : local * <p>This method does not use the sign bit. Callers can use it for differentiating language codes * from country codes, using the {@link #LANGUAGE} or {@link #COUNTRY} bit masks.</p> * - * @param code The 1-, 2- or 3- letters alpha code to convert. - * @param n Initial bit pattern, either {@link #LANGUAGE} or {@link #COUNTRY}. - * @return A number for the given code, or 0 if a non alpha characters were found. + * @param code the 1-, 2- or 3- letters alpha code to convert. + * @param n initial bit pattern, either {@link #LANGUAGE} or {@link #COUNTRY}. + * @return a number for the given code, or 0 if a non alpha characters were found. */ private static short toNumber(final String code, short n) { final int length = code.length(); @@ -355,8 +355,8 @@ filter: for (final Locale locale : local * Returns a unique instance of the given locale, if one is available. * Otherwise returns the {@code locale} unchanged. * - * @param locale The locale to canonicalize. - * @return A unique instance of the given locale, or {@code locale} if the given locale is not cached. + * @param locale the locale to canonicalize. + * @return a unique instance of the given locale, or {@code locale} if the given locale is not cached. */ public static Locale unique(final Locale locale) { final Locale candidate = POOL.get(locale);
Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/NullArgumentException.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -51,7 +51,7 @@ public class NullArgumentException exten /** * Constructs an exception with the specified detail message. * - * @param message The detail message. + * @param message the detail message. */ public NullArgumentException(final String message) { super(message); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Numbers.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -713,8 +713,8 @@ public final class Numbers extends Stati * {@link #SHORT}, {@link #BYTE}, {@link #CHARACTER}, {@link #BOOLEAN}, or {@link #OTHER} * constants for the given type. This is a commodity for usage in {@code switch} statements. * - * @param type A type (usually either a primitive type or its wrapper). - * @return The constant for the given type, or {@link #OTHER} if unknown. + * @param type a type (usually either a primitive type or its wrapper). + * @return the constant for the given type, or {@link #OTHER} if unknown. */ public static byte getEnumConstant(final Class<?> type) { final Numbers mapping = MAPPING.get(type); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/ObjectConverter.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -106,7 +106,7 @@ public interface ObjectConverter<S,T> ex * source value, then this properties set can not contain the {@link FunctionProperty#INJECTIVE} * value. See class javadoc for more discussion. * - * @return The manners in which source values are mapped to target values. + * @return the manners in which source values are mapped to target values. * May be an empty set, but never null. */ Set<FunctionProperty> properties(); @@ -114,14 +114,14 @@ public interface ObjectConverter<S,T> ex /** * Returns the type of objects to convert. * - * @return The type of objects to convert. + * @return the type of objects to convert. */ Class<S> getSourceClass(); /** * Returns the type of converted objects. * - * @return The type of converted objects. + * @return the type of converted objects. */ Class<T> getTargetClass(); @@ -131,17 +131,16 @@ public interface ObjectConverter<S,T> ex * throws an exception, at implementation choice. Note that this choice may affect the set of * function {@linkplain #properties() properties} - see the class Javadoc for more discussion. * - * @param object The object to convert, or {@code null}. - * @return The converted object, or {@code null}. - * @throws UnconvertibleObjectException If the given object is not an element of the function domain. + * @param object the object to convert, or {@code null}. + * @return the converted object, or {@code null}. + * @throws UnconvertibleObjectException if the given object is not an element of the function domain. */ @Override T apply(S object) throws UnconvertibleObjectException; /** - * Returns a converter capable to convert instances of <var>T</var> back to instances of - * <var>S</var>. Before to invoke this method, callers can verify if this converter is - * invertible as below: + * Returns a converter capable to convert instances of <var>T</var> back to instances of <var>S</var>. + * Before to invoke this method, callers can verify if this converter is invertible as below: * * {@preformat java * if (converter.properties().contains(FunctionProperty.INVERTIBLE)) { @@ -149,8 +148,8 @@ public interface ObjectConverter<S,T> ex * } * } * - * @return A converter for converting instances of <var>T</var> back to instances of <var>S</var>. - * @throws UnsupportedOperationException If this converter is not invertible. + * @return a converter for converting instances of <var>T</var> back to instances of <var>S</var>. + * @throws UnsupportedOperationException if this converter is not invertible. * * @see FunctionProperty#INVERTIBLE */ Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/StringBuilders.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/StringBuilders.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/StringBuilders.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/StringBuilders.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -283,8 +283,10 @@ public final class StringBuilders extend if (n == 2) { buffer.deleteCharAt(i + 1); // Remove the low surrogate of a surrogate pair. } - // Nothing special to do about codepoint here, since 'c' is in - // the basic plane (verified by the r < ASCII.length() check). + /* + * Nothing special to do about codepoint here, since 'c' is in + * the basic plane (verified by the r < ASCII.length() check). + */ buffer.setCharAt(i, cr); } } Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnconvertibleObjectException.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnconvertibleObjectException.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnconvertibleObjectException.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnconvertibleObjectException.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -47,7 +47,7 @@ public class UnconvertibleObjectExceptio /** * Constructs a new exception with the specified detail message. * - * @param message The detail message, or {@code null} if none. + * @param message the detail message, or {@code null} if none. */ public UnconvertibleObjectException(final String message) { super(message); @@ -56,8 +56,8 @@ public class UnconvertibleObjectExceptio /** * Constructs a new exception with the specified detail message and cause. * - * @param message The detail message, or {@code null} if none. - * @param cause The cause, or {@code null} if none. + * @param message the detail message, or {@code null} if none. + * @param cause the cause, or {@code null} if none. */ public UnconvertibleObjectException(final String message, final Throwable cause) { super(message, cause); @@ -66,7 +66,7 @@ public class UnconvertibleObjectExceptio /** * Constructs a new exception with the specified cause. * - * @param cause The cause, or {@code null} if none. + * @param cause the cause, or {@code null} if none. */ public UnconvertibleObjectException(final Throwable cause) { super(cause); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnknownNameException.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnknownNameException.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnknownNameException.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnknownNameException.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -47,7 +47,7 @@ public class UnknownNameException extend /** * Constructs a new exception with the specified detail message. * - * @param message The detail message, or {@code null} if none. + * @param message the detail message, or {@code null} if none. */ public UnknownNameException(final String message) { super(message); @@ -56,8 +56,8 @@ public class UnknownNameException extend /** * Constructs a new exception with the specified detail message and cause. * - * @param message The detail message, or {@code null} if none. - * @param cause The cause, or {@code null} if none. + * @param message the detail message, or {@code null} if none. + * @param cause the cause, or {@code null} if none. */ public UnknownNameException(final String message, final Throwable cause) { super(message, cause); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/UnsupportedImplementationException.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -39,7 +39,7 @@ public class UnsupportedImplementationEx /** * Constructs an exception with the specified detail message. * - * @param message The detail message, or {@code null} if none. + * @param message the detail message, or {@code null} if none. */ public UnsupportedImplementationException(final String message) { super(message); @@ -48,7 +48,7 @@ public class UnsupportedImplementationEx /** * Constructs an exception with an error message formatted for the specified class. * - * @param classe The unexpected implementation class. + * @param classe the unexpected implementation class. */ public UnsupportedImplementationException(final Class<?> classe) { super(Errors.format(Errors.Keys.UnsupportedImplementation_1, classe)); @@ -58,8 +58,8 @@ public class UnsupportedImplementationEx * Constructs an exception with an error message formatted for the specified class * and a cause. * - * @param classe The unexpected implementation class. - * @param cause The cause for the exception, or {@code null} if none. + * @param classe the unexpected implementation class. + * @param cause the cause for the exception, or {@code null} if none. */ public UnsupportedImplementationException(final Class<?> classe, final Exception cause) { super(Errors.format(Errors.Keys.UnsupportedImplementation_1, classe), cause); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/Workaround.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -47,7 +47,7 @@ public @interface Workaround { * A string identifying the library having a bug or limitation. * Examples: {@code "JDK"}, {@code "NetCDF"}, {@code "JUnit"}, {@code "SIS"}. * - * @return An identifier of the library having a bug or limitation. + * @return an identifier of the library having a bug or limitation. */ String library(); @@ -55,7 +55,7 @@ public @interface Workaround { * The last library version on which the bug has been verified. * The bug may have existed before, and may still exist later. * - * @return The library version on which the bug has been observed. + * @return the library version on which the bug has been observed. */ String version(); } Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Cache.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -129,8 +129,8 @@ import org.apache.sis.internal.jdk8.Supp * then creating <var>B</var> is not allowed to implies (directly or indirectly) the creation of * <var>A</var>. If this rule is not meet, deadlock may occur randomly. * - * @param <K> The type of key objects. - * @param <V> The type of value objects. + * @param <K> the type of key objects. + * @param <V> the type of value objects. * * @author Martin Desruisseaux (Geomatys) * @since 0.3 @@ -204,9 +204,9 @@ public class Cache<K,V> extends Abstract * of the {@linkplain #cost cost} of all values) before to replace eldest strong references by * {@linkplain Reference weak or soft references}.</p> * - * @param initialCapacity the initial capacity. - * @param costLimit The maximum number of objects to keep by strong reference. - * @param soft If {@code true}, use {@link SoftReference} instead of {@link WeakReference}. + * @param initialCapacity the initial capacity. + * @param costLimit the maximum number of objects to keep by strong reference. + * @param soft if {@code true}, use {@link SoftReference} instead of {@link WeakReference}. */ public Cache(int initialCapacity, final long costLimit, final boolean soft) { ArgumentChecks.ensureStrictlyPositive("initialCapacity", initialCapacity); @@ -224,8 +224,10 @@ public class Cache<K,V> extends Abstract @Override public void clear() { map.clear(); - // Do not update "costs" and "totalCost". Instead let adjustReferences(...) - // do its job, which needs to be done in a different thread. + /* + * Do not update "costs" and "totalCost". Instead let adjustReferences(…) + * do its job, which needs to be done in a different thread. + */ } /** @@ -243,7 +245,7 @@ public class Cache<K,V> extends Abstract * {@linkplain SoftReference soft} or {@linkplain WeakReference weak} references, and the * values under computation at the time this method is invoked. * - * @return The number of elements currently cached. + * @return the number of elements currently cached. */ @Override public int size() { @@ -253,7 +255,7 @@ public class Cache<K,V> extends Abstract /** * Returns {@code true} if this map contains the specified key. * - * @param key The key to check for existence. + * @param key the key to check for existence. * @return {@code true} if the given key still exist in this cache. */ @Override @@ -290,9 +292,9 @@ public class Cache<K,V> extends Abstract /** * Puts the given value in cache. * - * @param key The key for which to set a value. - * @param value The value to store. - * @return The value previously stored at the given key, or {@code null} if none. + * @param key the key for which to set a value. + * @param value the value to store. + * @return the value previously stored at the given key, or {@code null} if none. */ @Override public V put(final K key, final V value) { @@ -313,8 +315,8 @@ public class Cache<K,V> extends Abstract /** * Removes the value associated to the given key in the cache. * - * @param key The key of the value to removed. - * @return The value that were associated to the given key, or {@code null} if none. + * @param key the key of the value to removed. + * @return the value that were associated to the given key, or {@code null} if none. */ @Override public V remove(final Object key) { @@ -326,8 +328,8 @@ public class Cache<K,V> extends Abstract * {@link #peek} except that it blocks if the value is currently under computation in an * other thread. * - * @param key The key of the value to get. - * @return The value associated to the given key, or {@code null} if none. + * @param key the key of the value to get. + * @return the value associated to the given key, or {@code null} if none. */ @Override public V get(final Object key) { @@ -339,12 +341,10 @@ public class Cache<K,V> extends Abstract * is returned immediately. Otherwise the {@code creator.call()} method is invoked and * its result is saved in this cache for future reuse. * - * @param key The key for which to get the cached or created value. - * @param creator A method for creating a value, to be invoked only if no value are - * cached for the given key. - * @return The value for the given key, which may have been created as a result of this - * method call. - * @throws Exception If an exception occurred during the execution of {@code creator.call()}. + * @param key the key for which to get the cached or created value. + * @param creator a method for creating a value, to be invoked only if no value are cached for the given key. + * @return the value for the given key, which may have been created as a result of this method call. + * @throws Exception if an exception occurred during the execution of {@code creator.call()}. */ public V getOrCreate(final K key, final Callable<? extends V> creator) throws Exception { V value = peek(key); @@ -367,14 +367,16 @@ public class Cache<K,V> extends Abstract * This method is similar to {@link #get(Object)} except that it doesn't block if the value is * in process of being computed in an other thread; it returns {@code null} in such case. * - * @param key The key for which to get the cached value. - * @return The cached value for the given key, or {@code null} if there is none. + * @param key the key for which to get the cached value. + * @return the cached value for the given key, or {@code null} if there is none. */ public V peek(final K key) { final Object value = map.get(key); if (value instanceof Handler<?>) { - // The value is under computation. We will not wait for it since it is - // not the purpose of this method (we should use lock(key) for that). + /* + * The value is under computation. We will not wait for it since it is + * not the purpose of this method (we should use lock(key) for that). + */ return null; } if (value instanceof Reference<?>) { @@ -431,8 +433,8 @@ public class Cache<K,V> extends Abstract * } * } * - * @param key The key for the entry to lock. - * @return A handler to use for unlocking and storing the result. + * @param key the key for the entry to lock. + * @return a handler to use for unlocking and storing the result. */ public Handler<V> lock(final K key) { final Work handler = new Work(key); @@ -556,7 +558,7 @@ public class Cache<K,V> extends Abstract * * See the {@link Cache} javadoc for a more complete example. * - * @param <V> The type of value objects. + * @param <V> the type of value objects. * * @author Martin Desruisseaux (Geomatys) * @since 0.3 @@ -569,7 +571,7 @@ public class Cache<K,V> extends Abstract * This method should be invoked after the {@code Handler} creation in case a value * has been computed in an other thread. * - * @return The value from the cache, or {@code null} if none. + * @return the value from the cache, or {@code null} if none. */ V peek(); @@ -578,11 +580,11 @@ public class Cache<K,V> extends Abstract * <strong>must</strong> be invoked in a {@code finally} block, no matter * what the result is. * - * @param result The result to store in the cache, or {@code null} for removing + * @param result the result to store in the cache, or {@code null} for removing * the entry from the cache. If an entry is removed, a new computation * will be attempted the next time a handler is created for the same key. * - * @throws IllegalStateException May be thrown if this method is not invoked in + * @throws IllegalStateException may be thrown if this method is not invoked in * the pattern described in class javadoc, or if a key collision occurs. */ void putAndUnlock(V result) throws IllegalStateException; @@ -688,7 +690,7 @@ public class Cache<K,V> extends Abstract /** * Stores the result and release the lock. * - * @throws IllegalStateException If the current thread does not hold the lock. + * @throws IllegalStateException if the current thread does not hold the lock. */ @Override public void putAndUnlock(final V result) throws IllegalStateException { @@ -764,7 +766,7 @@ public class Cache<K,V> extends Abstract */ final void adjustReferences(final K key, final V value) { int cost = cost(value); - synchronized (costs) { // Should not be needed, but done as a safety. + synchronized (costs) { // Should not be needed, but done as a safety. final Integer old = costs.put(key, cost); if (old != null) { cost -= old; @@ -787,7 +789,7 @@ public class Cache<K,V> extends Abstract final Reference<V> ref = soft ? new Soft<>(map, oldKey, (V) oldValue) : new Weak<>(map, oldKey, (V) oldValue); if (!map.replace(oldKey, oldValue, ref)) { - ref.clear(); // Prevents the reference to be enqueued. + ref.clear(); // Prevents the reference to be enqueued. } } it.remove(); @@ -817,8 +819,10 @@ public class Cache<K,V> extends Abstract /** Removes the reference from the map. */ @Override public void dispose() { map.remove(key, this); - // There is nothing to remove from the cost map, since the later - // contains only the keys of objects hold by strong reference. + /* + * There is nothing to remove from the cost map, since the later + * contains only the keys of objects hold by strong reference. + */ } } @@ -840,8 +844,10 @@ public class Cache<K,V> extends Abstract /** Removes the reference from the map. */ @Override public void dispose() { map.remove(key, this); - // There is nothing to remove from the cost map, since the later - // contains only the keys of objects hold by strong reference. + /* + * There is nothing to remove from the cost map, since the later + * contains only the keys of objects hold by strong reference. + */ } } @@ -849,7 +855,7 @@ public class Cache<K,V> extends Abstract * Returns the set of keys in this cache. The returned set is subjects to the same caution * than the ones documented in the {@link ConcurrentHashMap#keySet()} method. * - * @return The set of keys in this cache. + * @return the set of keys in this cache. */ @Override public Set<K> keySet() { @@ -862,7 +868,7 @@ public class Cache<K,V> extends Abstract * it doesn't support removal of elements (including through the {@link Iterator#remove} * method call). * - * @return A view of the entries contained in this map. + * @return a view of the entries contained in this map. */ @Override public Set<Entry<K,V>> entrySet() { @@ -909,8 +915,8 @@ public class Cache<K,V> extends Abstract * in all cases. Subclasses should override this method if they have some easy way to measure * the relative cost of value objects. * - * @param value The object for which to get an estimation of its cost. - * @return The estimated cost of the given object. + * @param value the object for which to get an estimation of its cost. + * @return the estimated cost of the given object. * * @see java.lang.instrument.Instrumentation#getObjectSize(Object) */ Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CacheEntries.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CacheEntries.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CacheEntries.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CacheEntries.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -35,8 +35,8 @@ import java.lang.ref.Reference; * <div class="section">Thread safety</div> * This class is thread-safe if and only if the {@code Set} given to the constructor is thread-safe. * - * @param <K> The type of key objects. - * @param <V> The type of value objects. + * @param <K> the type of key objects. + * @param <V> the type of value objects. * * @author Martin Desruisseaux (Geomatys) * @since 0.3 @@ -52,7 +52,7 @@ final class CacheEntries<K,V> extends Ab /** * Wraps the given set of entries of a {@link Cache#map}. * - * @param entries The set of entries. Implementation shall support concurrency. + * @param entries the set of entries. Implementation shall support concurrency. */ CacheEntries(final Set<Map.Entry<K,Object>> entries) { this.entries = entries; @@ -84,8 +84,8 @@ final class CacheEntries<K,V> extends Ab } /** - * An iterator over the entries in the {@link Cache#map}. Handlers will be skipped and the - * values of weak references are returned instead of the {@link Reference} object. + * An iterator over the entries in the {@link Cache#map}. Handlers will be skipped and + * the values of weak references are returned instead of the {@link Reference} object. */ private static final class Iter<K,V> implements Iterator<Map.Entry<K,V>> { /** Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedContainer.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -23,6 +23,14 @@ import java.util.Collection; * A container that ensures that all elements are assignable to a given base type. * Checked containers are usually {@link Collection}, but not always. * + * <p><b>Constraint:</b> + * if a class implements both {@code CheckedContainer} and {@code Collection}, + * then the parameterized type shall be the same type. Example:</p> + * + * {@preformat java + * class MyList<E> extends AbstractList<E> implements CheckedContainer<E> { ... } + * } + * * @param <E> the base type of elements in the container. * * @author Martin Desruisseaux (IRD, Geomatys) Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/CodeListSet.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -112,8 +112,8 @@ public class CodeListSet<E extends CodeL * Creates an initially empty set for code lists of the given type. * The given {@code CodeList} type shall be final. * - * @param elementType The type of code list elements to be included in this set. - * @throws IllegalArgumentException If the given class is not final. + * @param elementType the type of code list elements to be included in this set. + * @throws IllegalArgumentException if the given class is not final. */ public CodeListSet(final Class<E> elementType) throws IllegalArgumentException { if (!Modifier.isFinal(elementType.getModifiers())) { @@ -129,10 +129,10 @@ public class CodeListSet<E extends CodeL * list elements are created after the invocation of this {@code CodeListSet} constructor, then * those new elements will <em>not</em> be in this set. * - * @param elementType The type of code list elements to be included in this set. + * @param elementType the type of code list elements to be included in this set. * @param fill {@code true} for filling the set with all known elements of the given type, * or {@code false} for leaving the set empty. - * @throws IllegalArgumentException If the given class is not final. + * @throws IllegalArgumentException if the given class is not final. */ public CodeListSet(final Class<E> elementType, final boolean fill) throws IllegalArgumentException { this(elementType); @@ -154,7 +154,7 @@ public class CodeListSet<E extends CodeL /** * Returns the type of code list elements in this set. * - * @return The type of code list elements in this set. + * @return the type of code list elements in this set. */ @Override public Class<E> getElementType() { @@ -199,7 +199,7 @@ public class CodeListSet<E extends CodeL /** * Returns the number of elements in this set. * - * @return The number of elements in this set. + * @return the number of elements in this set. */ @Override public int size() { @@ -214,7 +214,7 @@ public class CodeListSet<E extends CodeL /** * Adds the specified code list element in this set. * - * @param element The code list element to add in this set. + * @param element the code list element to add in this set. * @return {@code true} if this set has been modified as a consequence of this method call. */ @Override @@ -255,7 +255,7 @@ public class CodeListSet<E extends CodeL * This methods does nothing if the given argument is {@code null} or is * not an instance of the code list class specified at construction time. * - * @param object The code list element to remove from this set. + * @param object the code list element to remove from this set. * @return {@code true} if this set has been modified as a consequence of this method call. */ @Override @@ -288,7 +288,7 @@ public class CodeListSet<E extends CodeL * This methods returns {@code false} if the given argument is {@code null} or * is not an instance of the code list class specified at construction time. * - * @param object The element to test for presence in this set. + * @param object the element to test for presence in this set. * @return {@code true} if the given object is contained in this set. */ @Override @@ -310,7 +310,7 @@ public class CodeListSet<E extends CodeL /** * Returns {@code true} if this set contains all the elements of the given collection. * - * @param c The collection to be checked for containment in this set. + * @param c the collection to be checked for containment in this set. * @return {@code true} if this set contains all elements of the given collection. */ @Override @@ -345,14 +345,16 @@ public class CodeListSet<E extends CodeL /** * Adds all elements of the given collection to this set. * - * @param c The collection containing elements to be added to this set. + * @param c the collection containing elements to be added to this set. * @return {@code true} if this set changed as a result of this method call. */ @Override public boolean addAll(final Collection<? extends E> c) throws IllegalArgumentException { if (c instanceof CodeListSet) { final CodeListSet<?> o = (CodeListSet<?>) c; - // Following assertion should be ensured by parameterized types. + /* + * Following assertion should be ensured by parameterized types. + */ assert elementType.isAssignableFrom(o.elementType); boolean changed = (values != (values |= o.values)); /* @@ -391,7 +393,7 @@ public class CodeListSet<E extends CodeL /** * Adds all elements of the given collection from this set. * - * @param c The collection containing elements to be removed from this set. + * @param c the collection containing elements to be removed from this set. * @return {@code true} if this set changed as a result of this method call. */ @Override @@ -424,7 +426,7 @@ public class CodeListSet<E extends CodeL /** * Retains only the elements of the given collection in this set. * - * @param c The collection containing elements to retain in this set. + * @param c the collection containing elements to retain in this set. * @return {@code true} if this set changed as a result of this method call. */ @Override @@ -462,7 +464,7 @@ public class CodeListSet<E extends CodeL * this {@code CodeListSet} made after this method call will not affect the values * returned by the iterator. * - * @return An iterator over the elements in this set. + * @return an iterator over the elements in this set. */ @Override public Iterator<E> iterator() { @@ -542,7 +544,7 @@ public class CodeListSet<E extends CodeL /** * Returns a new set of the same class containing the same elements than this set. * - * @return A clone of this set. + * @return a clone of this set. */ @Override @SuppressWarnings("unchecked") @@ -551,7 +553,7 @@ public class CodeListSet<E extends CodeL try { clone = (CodeListSet<E>) super.clone(); } catch (CloneNotSupportedException e) { - throw new AssertionError(e); // Should never happen, since we are cloneable. + throw new AssertionError(e); // Should never happen, since we are cloneable. } final BitSet s = supplementary; if (s != null) { Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/Containers.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -54,7 +54,7 @@ public final class Containers extends St * pattern. In such cases, null collections (i.e. collections not yet instantiated) are typically * considered as {@linkplain Collection#isEmpty() empty}.</p> * - * @param collection the collection to test, or {@code null}. + * @param collection the collection to test, or {@code null}. * @return {@code true} if the given collection is null or empty, or {@code false} otherwise. */ public static boolean isNullOrEmpty(final Collection<?> collection) { Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DefaultTreeTable.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -125,8 +125,10 @@ public class DefaultTreeTable implements if (columns.length == 0) { throw new IllegalArgumentException(Errors.format(Errors.Keys.EmptyArgument_1, "columns")); } - // Copy the array for safety against user changes, and also for forcing the element type - // to TableColumn, not a subclass, because of the UnmodifiableArrayList.wrap(E[]) contract. + /* + * Copy the array for safety against user changes, and also for forcing the element type + * to TableColumn, not a subclass, because of the UnmodifiableArrayList.wrap(E[]) contract. + */ columns = Arrays.copyOf(columns, columns.length, TableColumn[].class); this.columnIndices = createColumnIndices(columns); this.columns = UnmodifiableArrayList.wrap(columns); @@ -529,7 +531,7 @@ public class DefaultTreeTable implements * cast will need to be replaced by an "instanceof" check. */ @Override - @SuppressWarnings("ReturnOfCollectionOrArrayField") // Returned list modifiable on intend. + @SuppressWarnings("ReturnOfCollectionOrArrayField") // Returned list is modifiable on intend. public final List<TreeTable.Node> getChildren() { if (children == null) { if (isLeaf()) { Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedIterator.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedIterator.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedIterator.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedIterator.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -25,8 +25,8 @@ import org.apache.sis.util.ObjectConvert * If a value is converted into a null value, then this iterator skips that value. * Consequently this iterator can not returns null value. * - * @param <S> The type of elements in the storage collection. - * @param <E> The type of elements in this set. + * @param <S> the type of elements in the storage collection. + * @param <E> the type of elements in this set. * * @author Martin Desruisseaux (IRD, Geomatys) * @since 0.3 Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedMap.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedMap.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedMap.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedMap.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -55,10 +55,10 @@ import org.apache.sis.math.FunctionPrope * If the storage map is known to be immutable, then sub-classes may consider to cache some values, * especially the result of the {@link #size()} method. * - * @param <SK> The type of keys in the storage map. - * @param <SV> The type of values in the storage map. - * @param <K> The type of keys in this map. - * @param <V> The type of values in this map. + * @param <SK> the type of keys in the storage map. + * @param <SV> the type of values in the storage map. + * @param <K> the type of keys in this map. + * @param <V> the type of values in this map. * * @author Martin Desruisseaux (IRD, Geomatys) * @since 0.3 @@ -105,9 +105,9 @@ class DerivedMap<SK,SV,K,V> extends Abst /** * Creates a new derived map from the specified storage map. * - * @param storage The map which actually store the entries. - * @param keyConverter The converter for the keys. - * @param valueConverter The converter for the values. + * @param storage the map which actually store the entries. + * @param keyConverter the converter for the keys. + * @param valueConverter the converter for the values. */ static <SK,SV,K,V> Map<K,V> create(final Map<SK,SV> storage, final ObjectConverter<SK,K> keyConverter, @@ -130,9 +130,9 @@ class DerivedMap<SK,SV,K,V> extends Abst /** * Creates a new derived map from the specified storage map. * - * @param storage The map which actually store the entries. - * @param keyConverter The converter for the keys. - * @param valueConverter The converter for the values. + * @param storage the map which actually store the entries. + * @param keyConverter the converter for the keys. + * @param valueConverter the converter for the values. */ private DerivedMap(final Map<SK,SV> storage, final ObjectConverter<SK,K> keyConverter, @@ -146,7 +146,7 @@ class DerivedMap<SK,SV,K,V> extends Abst /** * Returns the number of entries in this map. * - * @return The number of entries in this map. + * @return the number of entries in this map. */ @Override public int size() { @@ -166,8 +166,8 @@ class DerivedMap<SK,SV,K,V> extends Abst /** * Associates the specified value with the specified key in this map. * - * @param key key with which the specified value is to be associated. - * @param value value to be associated with the specified key. + * @param key key with which the specified value is to be associated. + * @param value value to be associated with the specified key. * @return previous value associated with specified key, or {@code null} * if there was no mapping for key. * @throws UnsupportedOperationException if the converters are not invertible, @@ -303,6 +303,7 @@ class DerivedMap<SK,SV,K,V> extends Abst * Returns a set view of the keys contained in this map. */ @Override + @SuppressWarnings("ReturnOfCollectionOrArrayField") // Safe because immutable. public final Set<K> keySet() { if (keySet == null) { keySet = DerivedSet.create(storage.keySet(), keyConverter); @@ -314,6 +315,7 @@ class DerivedMap<SK,SV,K,V> extends Abst * Returns a set view of the mappings contained in this map. */ @Override + @SuppressWarnings("ReturnOfCollectionOrArrayField") // Safe because immutable. public final Set<Map.Entry<K,V>> entrySet() { if (entrySet == null) { entrySet = DerivedSet.create(storage.entrySet(), this); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedSet.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedSet.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedSet.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/DerivedSet.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -53,8 +53,8 @@ import org.apache.sis.internal.util.SetO * If the storage set is known to be immutable, then sub-classes may consider to cache some values, * especially the result of the {@link #size()} method. * - * @param <S> the type of elements in the storage set. - * @param <E> the type of elements in this set. + * @param <S> the type of elements in the storage set. + * @param <E> the type of elements in this set. * * @author Martin Desruisseaux (IRD, Geomatys) * @since 0.3 @@ -80,8 +80,8 @@ class DerivedSet<S,E> extends SetOfUnkno /** * Creates a new derived set from the specified storage set. * - * @param storage The set which actually store the elements. - * @param converter The converter from the type in the storage set to the type in the derived set. + * @param storage the set which actually store the elements. + * @param converter the converter from the type in the storage set to the type in the derived set. */ static <S,E> Set<E> create(final Set<S> storage, final ObjectConverter<S,E> converter) { final Set<FunctionProperty> properties = converter.properties(); @@ -171,8 +171,8 @@ class DerivedSet<S,E> extends SetOfUnkno * allows us to delegate the {@link #contains(Object)} and {@linkplain #remove(Object)} * operations to the {@linkplain #storage} set instead than iterating over all elements. * - * @param <S> the type of elements in the storage set. - * @param <E> the type of elements in this set. + * @param <S> the type of elements in the storage set. + * @param <E> the type of elements in this set. */ private static class Invertible<S,E> extends DerivedSet<S,E> { /** @@ -188,8 +188,8 @@ class DerivedSet<S,E> extends SetOfUnkno /** * Creates a new derived set from the specified storage set. * - * @param storage The set which actually store the elements. - * @param converter The type of elements in this derived set. + * @param storage the set which actually store the elements. + * @param converter the type of elements in this derived set. */ Invertible(final Set<S> storage, final ObjectConverter<S,E> converter) { super(storage, converter); @@ -213,7 +213,7 @@ class DerivedSet<S,E> extends SetOfUnkno * return storage.contains(inverse.apply(element)); * } * - * @param element object to be checked for containment in this set. + * @param element object to be checked for containment in this set. * @return {@code true} if this set contains the specified element. */ @Override @@ -231,7 +231,7 @@ class DerivedSet<S,E> extends SetOfUnkno * return storage.remove(inverse.apply(element)); * } * - * @param element element to be removed from this set, if present. + * @param element element to be removed from this set, if present. * @return {@code true} if the set contained the specified element. * @throws UnsupportedOperationException if the {@linkplain #storage} set doesn't * supports the {@code remove} operation. @@ -248,8 +248,8 @@ class DerivedSet<S,E> extends SetOfUnkno * The bijection allows us to query the {@linkplain #storage} set size directly * instead than iterating over all elements. * - * @param <S> the type of elements in the storage set. - * @param <E> the type of elements in this set. + * @param <S> the type of elements in the storage set. + * @param <E> the type of elements in this set. */ private static final class Bijective<S,E> extends Invertible<S,E> { /** @@ -260,8 +260,8 @@ class DerivedSet<S,E> extends SetOfUnkno /** * Creates a new derived set from the specified storage set. * - * @param storage The set which actually store the elements. - * @param converter The type of elements in this derived set. + * @param storage the set which actually store the elements. + * @param converter the type of elements in this derived set. */ Bijective(final Set<S> storage, final ObjectConverter<S,E> converter) { super(storage, converter); Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/RangeSet.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -128,7 +128,7 @@ public class RangeSet<E extends Comparab * comparator throws an exception. Such ambiguities should not happen in sequences * of ranges created by {@code RangeSet}.</p> * - * @param <E> The type of range elements. + * @param <E> the type of range elements. * * @author Martin Desruisseaux (Geomatys) * @since 0.3 @@ -176,11 +176,10 @@ public class RangeSet<E extends Comparab cmax = included ? +1 : -1; } } - if (cmin == cmax) return cmax; // Easy case: min and max are both greater, smaller or eq. - if (cmin == 0) return cmax; // Easy case: only max value differ. - if (cmax == 0) return cmin; // Easy case: only min value differ. - // One range is included in the other. - throw new IllegalArgumentException(Errors.format( + if (cmin == cmax) return cmax; // Easy case: min and max are both greater, smaller or eq. + if (cmin == 0) return cmax; // Easy case: only max value differ. + if (cmax == 0) return cmin; // Easy case: only min value differ. + throw new IllegalArgumentException(Errors.format( // One range is included in the other. Errors.Keys.UndefinedOrderingForElements_2, r1, r2)); } @@ -270,8 +269,10 @@ public class RangeSet<E extends Comparab this.isMinIncluded = isMinIncluded; this.isMaxIncluded = isMaxIncluded; if (!isMinIncluded && !isMaxIncluded) { - // We do not localize this error message because it may disaspear - // in a future SIS version if we decide to support closed intervals. + /* + * We do not localize this error message because it may disaspear + * in a future SIS version if we decide to support closed intervals. + */ throw new IllegalArgumentException("Open intervals are not yet supported."); } } @@ -283,7 +284,7 @@ public class RangeSet<E extends Comparab * @param elementType the type of the range elements. * @param isMinIncluded {@code true} if the minimal values are inclusive, or {@code false} if exclusive. * @param isMaxIncluded {@code true} if the maximal values are inclusive, or {@code false} if exclusive. - * @return A new range set for range elements of the given type. + * @return a new range set for range elements of the given type. */ @SuppressWarnings({"unchecked","rawtypes"}) public static <E extends Comparable<? super E>> RangeSet<E> create(final Class<E> elementType, @@ -339,6 +340,7 @@ public class RangeSet<E extends Comparab /** * Unconditionally copies the internal array in a new array having just the required length. */ + @SuppressWarnings("SuspiciousSystemArraycopy") private void reallocate() { if (length == 0) { array = null; @@ -370,6 +372,7 @@ public class RangeSet<E extends Comparab * @param minValue the first value to insert. * @param maxValue the second value to insert. */ + @SuppressWarnings("SuspiciousSystemArraycopy") private void insertAt(final int lower, final E minValue, final E maxValue) { final Object oldArray = array; final int capacity = Array.getLength(oldArray); @@ -391,6 +394,7 @@ public class RangeSet<E extends Comparab * @param lower first value to remove, inclusive. * @param upper last value to remove, exclusive. */ + @SuppressWarnings("SuspiciousSystemArraycopy") private void removeAt(final int lower, final int upper) { final int oldLength = length; System.arraycopy(array, upper, array, lower, oldLength - upper); @@ -826,13 +830,17 @@ public class RangeSet<E extends Comparab if (lower < 0) { lower = ~lower; if ((lower & 1) == 0) { - // The lower endpoint of the given range falls between - // two ranges of this set. + /* + * The lower endpoint of the given range falls between + * two ranges of this set. + */ return false; } } else if ((lower & 1) == 0) { - // Lower endpoint of the given range matches exactly - // the lower endpoint of a range in this set. + /* + * Lower endpoint of the given range matches exactly + * the lower endpoint of a range in this set. + */ if (!isMinIncluded && range.isMinIncluded()) { return false; } @@ -845,13 +853,17 @@ public class RangeSet<E extends Comparab if (upper < 0) { upper = ~upper; if ((upper & 1) == 0) { - // The upper endpoint of the given range falls between - // two ranges of this set, or is after all ranges. + /* + * The upper endpoint of the given range falls between + * two ranges of this set, or is after all ranges. + */ return false; } } else if ((upper & 1) != 0) { - // Upper endpoint of the given range matches exactly - // the upper endpoint of a range in this set. + /* + * Upper endpoint of the given range matches exactly + * the upper endpoint of a range in this set. + */ if (!isMaxIncluded && range.isMaxIncluded()) { return false; } @@ -1112,7 +1124,7 @@ public class RangeSet<E extends Comparab @Override public boolean remove(Object object) { if (object instanceof Range<?>) { - @SuppressWarnings("unchecked") // Type will actally be checked on the line after. + @SuppressWarnings("unchecked") // Type will actally be checked on the line after. final Range<E> range = (Range<E>) object; if (range.getElementType() == elementType) { object = subRange.intersect(range); @@ -1129,7 +1141,7 @@ public class RangeSet<E extends Comparab @Override public boolean contains(final Object object) { if (object instanceof Range<?>) { - @SuppressWarnings("unchecked") // Type will actally be checked on the line after. + @SuppressWarnings("unchecked") // Type will actally be checked on the line after. final Range<E> range = (Range<E>) object; if (range.getElementType() == elementType) { if (!subRange.contains(range)) { @@ -1351,8 +1363,10 @@ public class RangeSet<E extends Comparab } final Range<E> range = getRange(position); if (RangeSet.this.modCount != this.modCount) { - // Check it last, in case a change occurred - // while we were creating the range. + /* + * This check has been performed last in case a change occurred + * while we were creating the range. + */ throw new ConcurrentModificationException(); } position += 2; @@ -1391,8 +1405,10 @@ public class RangeSet<E extends Comparab public int indexOfRange(final E value) { int index = binarySearch(value, 0, length); if (index < 0) { - // Found an insertion point. Make sure that the insertion - // point is inside a range (i.e. before the maximum value). + /* + * Found an insertion point. Make sure that the insertion + * point is inside a range (i.e. before the maximum value). + */ index = ~index; // Tild sign, not minus. if ((index & 1) == 0) { return -1; @@ -1401,7 +1417,7 @@ public class RangeSet<E extends Comparab // The value is equals to an excluded endpoint. return -1; } - index /= 2; // Round toward 0 (odd index are maximum values). + index /= 2; // Round toward 0 (odd index are maximum values). return index; } Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTables.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTables.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTables.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/TreeTables.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -131,10 +131,10 @@ public final class TreeTables extends St * └─data * } * - * @param from The root node from which to start the search. - * @param column The column containing the file name. - * @param path The path for which to find or create a node. - * @return The node for the given path, either as an existing node or a new node. + * @param from the root node from which to start the search. + * @param column the column containing the file name. + * @param path the path for which to find or create a node. + * @return the node for the given path, either as an existing node or a new node. */ public static TreeTable.Node nodeForPath(TreeTable.Node from, final TableColumn<? super String> column, final Path path) @@ -163,10 +163,10 @@ public final class TreeTables extends St * This method performs the same work than the above variant, but working on * {@code File} instances rather than {@code Path}. * - * @param from The root node from which to start the search. - * @param column The column containing the file name. - * @param path The file for which to find or create a node. - * @return The node for the given file, either as an existing node or a new node. + * @param from the root node from which to start the search. + * @param column the column containing the file name. + * @param path the file for which to find or create a node. + * @return the node for the given file, either as an existing node or a new node. */ public static TreeTable.Node nodeForPath(TreeTable.Node from, final TableColumn<? super String> column, final File path) @@ -177,7 +177,7 @@ public final class TreeTables extends St } String name = path.getName(); if (name.isEmpty() && parent == null) { - name = File.separator; // Root directory. + name = File.separator; // Root directory in Unix path syntax. } for (final TreeTable.Node child : from.getChildren()) { if (name.equals(child.getValue(column))) { @@ -197,9 +197,9 @@ public final class TreeTables extends St * <p>This method may be invoked before to serialize the table in order to reduce the * serialization stream size.</p> * - * @param table The table in which to replace values by their string representations. - * @param locale The locale to use when replacing {@link InternationalString} instances. Can be {@code null}. - * @return Number of replacements done. + * @param table the table in which to replace values by their string representations. + * @param locale the locale to use when replacing {@link InternationalString} instances. Can be {@code null}. + * @return number of replacements done. */ @SuppressWarnings({"unchecked", "rawtypes"}) public static int replaceCharSequences(final TreeTable table, final Locale locale) { @@ -219,11 +219,11 @@ public final class TreeTables extends St /** * Implementation of the public {@link #replaceCharSequences(TreeTable, Locale)} method. * - * @param node The node in which to replace values by their string representations. - * @param columns The columns where to perform the replacements. - * @param locale The locale to use when replacing {@link InternationalString} instances. Can be {@code null}. - * @param pool An initially empty pool of string representations, to be filled by this method. - * @return Number of replacements done. + * @param node the node in which to replace values by their string representations. + * @param columns the columns where to perform the replacements. + * @param locale the locale to use when replacing {@link InternationalString} instances. Can be {@code null}. + * @param pool an initially empty pool of string representations, to be filled by this method. + * @return number of replacements done. */ private static int replaceCharSequences(final TreeTable.Node node, final TableColumn<? super String>[] columns, final Locale locale, final Map<String,String> pool) @@ -262,8 +262,8 @@ public final class TreeTables extends St * developers are encouraged to create and configure their own {@code TreeTableFormat} * instance. * - * @param table The tree table to format. - * @return A string representation of the given tree table. + * @param table the tree table to format. + * @return a string representation of the given tree table. */ public static String toString(final TreeTable table) { ArgumentChecks.ensureNonNull("table", table); @@ -277,11 +277,11 @@ public final class TreeTables extends St * This helper method is sometime useful for quick tests or debugging purposes. * For more extensive use, consider using {@link TreeTableFormat} instead. * - * @param tree The string representation of the tree to parse. - * @param labelColumn The columns where to store the node labels. This is often {@link TableColumn#NAME}. - * @param otherColumns Optional columns where to store the values, if any. - * @return A tree parsed from the given string. - * @throws ParseException If an error occurred while parsing the tree. + * @param tree the string representation of the tree to parse. + * @param labelColumn the columns where to store the node labels. This is often {@link TableColumn#NAME}. + * @param otherColumns optional columns where to store the values, if any. + * @return a tree parsed from the given string. + * @throws ParseException if an error occurred while parsing the tree. */ public static TreeTable parse(final String tree, final TableColumn<?> labelColumn, final TableColumn<?>... otherColumns) throws ParseException Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakEntry.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakEntry.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakEntry.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakEntry.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -164,7 +164,7 @@ abstract class WeakEntry<E> extends Weak for (WeakEntry<E> next : oldTable) { while (next != null) { final WeakEntry<E> e = next; - next = next.next; // We keep 'next' right now because its value will change. + next = next.next; // We keep 'next' right now because its value will change. final int index = e.hash % table.length; e.next = table[index]; table[index] = e; Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakHashSet.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakHashSet.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakHashSet.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakHashSet.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -17,6 +17,7 @@ package org.apache.sis.util.collection; import java.util.Arrays; +import java.util.Objects; import java.util.Iterator; import java.util.AbstractSet; import java.lang.reflect.Array; @@ -29,9 +30,6 @@ import org.apache.sis.util.NullArgumentE import static org.apache.sis.util.collection.WeakEntry.*; -// Branch-dependent imports -import java.util.Objects; - /** * A set of objects hold by weak references. An entry in a {@code WeakHashSet} will automatically @@ -284,9 +282,11 @@ public class WeakHashSet<E> extends Abst * or the given {@code object} otherwise. */ public synchronized <T extends E> T unique(final T element) { - // There is no way to make sure that this operation is really safe. - // We have to trust the Object.equals(Object) method to be strict - // about the type of compared objects. + /* + * There is no way to make sure that this operation is really safe. + * We have to trust the Object.equals(Object) method to be strict + * about the type of compared objects. + */ return (T) intern(element, INTERN); } Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakValueHashMap.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakValueHashMap.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakValueHashMap.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/collection/WeakValueHashMap.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -21,6 +21,7 @@ import java.util.Set; import java.util.AbstractMap; import java.util.AbstractSet; import java.util.Iterator; +import java.util.Objects; import java.util.Arrays; import java.lang.reflect.Array; import java.lang.ref.WeakReference; @@ -33,9 +34,6 @@ import org.apache.sis.util.resources.Err import static org.apache.sis.util.collection.WeakEntry.*; -// Branch-dependent imports -import java.util.Objects; - /** * A hashtable-based map implementation that uses {@linkplain WeakReference weak references}, Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractFactory.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractFactory.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractFactory.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/AbstractFactory.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -41,7 +41,7 @@ public abstract class AbstractFactory im * The default implementation tries to fetch this information from the * manifest associated to the package of {@code this.getClass()}. * - * @return The vendor for this factory implementation, or {@code null} if unknown. + * @return the vendor for this factory implementation, or {@code null} if unknown. * * @see Package#getImplementationVendor() */ Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultInternationalString.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultInternationalString.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultInternationalString.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultInternationalString.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -26,6 +26,7 @@ import java.util.LinkedHashMap; import java.util.Collections; import java.util.Iterator; import java.util.Locale; +import java.util.Objects; import java.util.logging.Level; import java.util.logging.LogRecord; import org.opengis.util.InternationalString; @@ -37,9 +38,6 @@ import org.apache.sis.util.resources.Mes import org.apache.sis.util.collection.Containers; import org.apache.sis.internal.system.Modules; -// Branch-dependent imports -import java.util.Objects; - /** * An international string using a map of strings for different locales. @@ -90,7 +88,7 @@ public class DefaultInternationalString * The string specified to this constructor is the one that will be returned if no localized * string is found for the {@code Locale} argument in a call to {@link #toString(Locale)}. * - * @param string The string in no specific locale, or {@code null} if none. + * @param string the string in no specific locale, or {@code null} if none. */ public DefaultInternationalString(final String string) { if (string != null) { @@ -105,7 +103,7 @@ public class DefaultInternationalString * The content of the given map is copied, so changes to that map after construction * will not be reflected into this international string. * - * @param strings The strings in various locales, or {@code null} if none. + * @param strings the strings in various locales, or {@code null} if none. * * @see Types#toInternationalString(Map, String) */ @@ -132,8 +130,8 @@ public class DefaultInternationalString /** * Adds a string for the given locale. * - * @param locale The locale for the {@code string} value. - * @param string The localized string. + * @param locale the locale for the {@code string} value. + * @param string the localized string. * @throws IllegalArgumentException if a different string value was already set for the given locale. */ public synchronized void add(final Locale locale, final String string) throws IllegalArgumentException { @@ -143,7 +141,7 @@ public class DefaultInternationalString case 0: { localeMap = Collections.singletonMap(locale, string); localeSet = null; - defaultValue = null; // Will be recomputed when first needed. + defaultValue = null; // Will be recomputed when first needed. return; } case 1: { @@ -162,15 +160,15 @@ public class DefaultInternationalString throw new IllegalArgumentException(Errors.format( Errors.Keys.ValueAlreadyDefined_1, locale)); } - defaultValue = null; // Will be recomputed when first needed. + defaultValue = null; // Will be recomputed when first needed. } /** * Adds the given character sequence. If the given sequence is an other {@link InternationalString} instance, * then only the string for the given locale is added. This method is for {@link Types} internal usage only. * - * @param locale The locale for the {@code string} value. - * @param string The character sequence to add. + * @param locale the locale for the {@code string} value. + * @param string the character sequence to add. * @throws IllegalArgumentException if a different string value was already set for the given locale. */ final void add(final Locale locale, final CharSequence string) throws IllegalArgumentException { @@ -194,7 +192,7 @@ public class DefaultInternationalString /** * Returns the set of locales defined in this international string. * - * @return The set of locales. + * @return the set of locales. * * @todo Current implementation does not return a synchronized set. We should synchronize * on the same lock than the one used for accessing the internal locale map. @@ -218,8 +216,8 @@ public class DefaultInternationalString * {@linkplain Locale#getCountry() country} part. If none are found, then this method returns * {@code null}. * - * @param locale The locale to look for, or {@code null}. - * @return The string in the specified locale, or {@code null} if none was found. + * @param locale the locale to look for, or {@code null}. + * @return the string in the specified locale, or {@code null} if none was found. */ private String getString(Locale locale) { while (locale != null) { @@ -277,8 +275,8 @@ public class DefaultInternationalString * {@code Locale.ROOT}. However subclasses are free to use a different fallback. Client * code are encouraged to specify only non-null values for more determinist behavior. * - * @param locale The desired locale for the string to be returned. - * @return The string in the given locale if available, or in an + * @param locale the desired locale for the string to be returned. + * @return the string in the given locale if available, or in an * implementation-dependent fallback locale otherwise. */ @Override @@ -302,8 +300,8 @@ public class DefaultInternationalString */ text = localeMap.get(Locale.ROOT); if (text == null) { - Locale fallback = Locale.US; // The fallback language for "unlocalized" string. - if (fallback != locale) { // Avoid requesting the same locale twice (optimization). + Locale fallback = Locale.US; // The fallback language for "unlocalized" string. + if (fallback != locale) { // Avoid requesting the same locale twice (optimization). text = getString(fallback); if (text != null) { return text; @@ -316,8 +314,10 @@ public class DefaultInternationalString return text; } } - // Every else failed; pickup a random string. - // This behavior may change in future versions. + /* + * Every else failed; pickup a random string. + * This behavior may change in future versions. + */ final Iterator<String> it = localeMap.values().iterator(); if (it.hasNext()) { text = it.next(); @@ -350,9 +350,8 @@ public class DefaultInternationalString * <li>Otherwise, this method returns {@code false}.</li> * </ul> * - * @param candidate The object which may contains this international string. - * @return {@code true} if the given object contains all localized strings found in this - * international string. + * @param candidate the object which may contains this international string. + * @return {@code true} if the given object contains all localized strings found in this international string. */ public synchronized boolean isSubsetOf(final Object candidate) { if (candidate instanceof InternationalString) { @@ -383,7 +382,7 @@ public class DefaultInternationalString /** * Compares this international string with the specified object for equality. * - * @param object The object to compare with this international string. + * @param object the object to compare with this international string. * @return {@code true} if the given object is equal to this string. */ @Override @@ -398,7 +397,7 @@ public class DefaultInternationalString /** * Returns a hash code value for this international text. * - * @return A hash code value for this international text. + * @return a hash code value for this international text. */ @Override public synchronized int hashCode() { @@ -408,9 +407,9 @@ public class DefaultInternationalString /** * Canonicalize the locales after deserialization. * - * @param in The input stream from which to deserialize an international string. - * @throws IOException If an I/O error occurred while reading or if the stream contains invalid data. - * @throws ClassNotFoundException If the class serialized on the stream is not on the classpath. + * @param in the input stream from which to deserialize an international string. + * @throws IOException if an I/O error occurred while reading or if the stream contains invalid data. + * @throws ClassNotFoundException if the class serialized on the stream is not on the classpath. */ private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException { in.defaultReadObject(); @@ -418,7 +417,7 @@ public class DefaultInternationalString if (size == 0) { return; } - @SuppressWarnings({"unchecked","rawtypes"}) // Generic array creation. + @SuppressWarnings({"unchecked","rawtypes"}) // Generic array creation. Map.Entry<Locale,String>[] entries = new Map.Entry[size]; entries = localeMap.entrySet().toArray(entries); if (size == 1) { Modified: sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java URL: http://svn.apache.org/viewvc/sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java?rev=1779559&r1=1779558&r2=1779559&view=diff ============================================================================== --- sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java [UTF-8] (original) +++ sis/trunk/core/sis-utility/src/main/java/org/apache/sis/util/iso/DefaultLocalName.java [UTF-8] Fri Jan 20 04:34:26 2017 @@ -174,7 +174,7 @@ public class DefaultLocalName extends Ab final NameSpace scope = object.scope(); final InternationalString name = object.toInternationalString(); if (scope instanceof DefaultNameSpace) { - return ((DefaultNameSpace) scope).local(name, null); // May return a cached instance. + return ((DefaultNameSpace) scope).local(name, null); // May return a cached instance. } else { return new DefaultLocalName(scope, name); }
