Author: desruisseaux
Date: Thu Sep 20 10:37:56 2012
New Revision: 1387952
URL: http://svn.apache.org/viewvc?rev=1387952&view=rev
Log:
Javadoc fixes (remove irrelevant @since javadoc tags).
Modified:
incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/UnmodifiableMetadataException.java
incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Arrays.java
incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Classes.java
Modified: incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/UnmodifiableMetadataException.java
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/UnmodifiableMetadataException.java?rev=1387952&r1=1387951&r2=1387952&view=diff
==============================================================================
--- incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/UnmodifiableMetadataException.java
(original)
+++ incubator/sis/trunk/sis-metadata/src/main/java/org/apache/sis/metadata/UnmodifiableMetadataException.java
Thu Sep 20 10:37:56 2012
@@ -22,10 +22,9 @@ package org.apache.sis.metadata;
* {@linkplain org.apache.sis.metadata.ModifiableMetadata modifiable metadata},
* but this metadata has since be declared unmodifiable.
*
- * @author Martin Desruisseaux (Geomatys)
- * @version 3.00
- *
- * @since 2.4
+ * @author Martin Desruisseaux (IRD, Geomatys)
+ * @since 0.3 (derived from geotk-2.4)
+ * @version 0.3
* @module
*/
public class UnmodifiableMetadataException extends UnsupportedOperationException {
Modified: incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Arrays.java
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Arrays.java?rev=1387952&r1=1387951&r2=1387952&view=diff
==============================================================================
--- incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Arrays.java (original)
+++ incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Arrays.java Thu Sep
20 10:37:56 2012
@@ -1067,8 +1067,6 @@ public final class Arrays extends Static
* @return A copy of the given array with the given element appended at the end.
*
* @see #concatenate(Object[][])
- *
- * @since 3.20
*/
public static <T> T[] append(final T[] array, final T element) {
ArgumentChecks.ensureNonNull("array", array);
@@ -1103,8 +1101,6 @@ public final class Arrays extends Static
* @param array Array from which to remove duplicated elements, or {@code null}.
* @return The number of remaining elements in the given array, or 0 if the given
* {@code array}Â was null.
- *
- * @since 3.20
*/
public static int removeDuplicated(final Object[] array) {
if (array == null) {
@@ -1130,8 +1126,6 @@ public final class Arrays extends Static
* If the given array is {@code null}, then this method does nothing.
*
* @param entries The array in which to reverse the order of elements, or {@code null}
if none.
- *
- * @since 3.11
*/
public static void reverse(final Object[] entries) {
if (entries != null) {
Modified: incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java?rev=1387952&r1=1387951&r2=1387952&view=diff
==============================================================================
--- incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java (original)
+++ incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java Thu
Sep 20 10:37:56 2012
@@ -267,8 +267,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static double[] parseDoubles(final String values, final char separator) throws
NumberFormatException {
final String[] tokens = split(values, separator);
@@ -289,8 +287,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static float[] parseFloats(final String values, final char separator) throws NumberFormatException
{
final String[] tokens = split(values, separator);
@@ -312,8 +308,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static long[] parseLongs(final String values, final char separator, final int
radix) throws NumberFormatException {
final String[] tokens = split(values, separator);
@@ -334,8 +328,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static int[] parseInts(final String values, final char separator, final int radix)
throws NumberFormatException {
final String[] tokens = split(values, separator);
@@ -356,8 +348,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static short[] parseShorts(final String values, final char separator, final int
radix) throws NumberFormatException {
final String[] tokens = split(values, separator);
@@ -378,8 +368,6 @@ public final class CharSequences extends
* @return The array of numbers parsed from the given string,
* or an empty array if {@code values} was null.
* @throws NumberFormatException If at least one number can not be parsed.
- *
- * @since 3.19
*/
public static byte[] parseBytes(final String values, final char separator, final int
radix) throws NumberFormatException {
final String[] tokens = split(values, separator);
@@ -411,8 +399,6 @@ public final class CharSequences extends
* @param separator The element separator, which is usually {@code ", "}.
* @return The (typically) comma-separated list, or {@code null} if the given {@code
collection}
* was null or contains only null elements.
- *
- * @since 3.20
*/
public static String formatList(final Iterable<?> collection, final String separator)
{
ArgumentChecks.ensureNonNull("separator", separator);
@@ -475,8 +461,6 @@ public final class CharSequences extends
* @throws NullPointerException if the {@code buffer} or {@code chars} argument is null.
*
* @see StringBuilder#replace(int, int, String)
- *
- * @since 3.20
*/
public static void replace(final StringBuilder buffer, int start, final int end, final
char[] chars) {
int length = end - start;
@@ -626,8 +610,6 @@ public final class CharSequences extends
* or {@code null}.
* @return The given text with substitution applied, or {@code text}Â if no replacement
* has been applied.
- *
- * @since 3.18
*/
public static CharSequence toASCII(CharSequence text) {
if (text != null) {
@@ -685,8 +667,6 @@ public final class CharSequences extends
* or {@code null}.
* @return The identifier with spaces inserted after what looks like words, or {@code
null}
* if the given argument was null.
- *
- * @since 3.18 (derived from 3.09)
*/
public static String camelCaseToSentence(final CharSequence identifier) {
if (identifier == null) {
@@ -935,8 +915,6 @@ cmp: while (ia < lga) {
* like {@code "UTF-8"} or {@code "ISO-LATIN-1"}.
*
* @see #isJavaIdentifier(CharSequence)
- *
- * @since 3.18 (derived from 3.17)
*/
private static boolean isCode(final CharSequence identifier) {
for (int i=identifier.length(); --i>=0;) {
Modified: incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Classes.java
URL: http://svn.apache.org/viewvc/incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Classes.java?rev=1387952&r1=1387951&r2=1387952&view=diff
==============================================================================
--- incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Classes.java (original)
+++ incubator/sis/trunk/sis-utility/src/main/java/org/apache/sis/util/Classes.java Thu Sep
20 10:37:56 2012
@@ -236,8 +236,6 @@ public final class Classes extends Stati
* or {@code null} if this cast can not be performed.
*
* @see Class#asSubclass(Class)
- *
- * @since 3.09
*/
@SuppressWarnings({"unchecked","rawtypes"})
public static <U> Class<? extends U> asSubclassOrNull(final Class<?>
type, final Class<U> sub) {
@@ -278,8 +276,6 @@ public final class Classes extends Stati
* @param <T> The base type of elements in the given collection.
* @param objects The collection of objects.
* @return The set of classes of all objects in the given collection.
- *
- * @since 3.00
*/
public static <T> Set<Class<? extends T>> getClasses(final Collection<?
extends T> objects) {
final Set<Class<? extends T>> types = new LinkedHashSet<Class<?
extends T>>();
@@ -299,8 +295,6 @@ public final class Classes extends Stati
* @param type The class or interface for which to get all implemented interfaces.
* @return All implemented interfaces (not including the given {@code type} if it was
an
* interface), or an empty set if none. Callers can freely modify the returned
set.
- *
- * @since 3.01
*/
public static Set<Class<?>> getAllInterfaces(Class<?> type) {
final Set<Class<?>> interfaces = new LinkedHashSet<Class<?>>();
@@ -338,8 +332,6 @@ public final class Classes extends Stati
* @param baseInterface The base type of the interface to search.
* @return The leaf interfaces matching the given criterion, or {@code null} if none.
* If non-null, than the array is guaranteed to contain at least one element.
- *
- * @since 3.18
*/
@SuppressWarnings("unchecked")
public static <T> Class<? extends T>[] getLeafInterfaces(Class<?> type,
final Class<T> baseInterface) {
@@ -388,8 +380,6 @@ next: for (final Class<?> candidat
* @param objects A collection of objects. May contains duplicated values and null values.
* @return The most specialized class, or {@code null} if the given collection does not
contain
* at least one non-null element.
- *
- * @since 3.01 (derived from 2.5)
*/
public static Class<?> findSpecializedClass(final Collection<?> objects)
{
final Set<Class<?>> types = getClasses(objects);
@@ -442,8 +432,6 @@ next: for (final Class<?> candidat
* @param objects A collection of objects. May contains duplicated values and null values.
* @return The most specific class common to all supplied objects, or {@code null} if
the
* given collection does not contain at least one non-null element.
- *
- * @since 3.01 (derived from 2.5)
*/
public static Class<?> findCommonClass(final Collection<?> objects) {
final Set<Class<?>> types = getClasses(objects);
@@ -462,8 +450,6 @@ next: for (final Class<?> candidat
* @param c2 The second class, or {@code null}.
* @return The most specific class common to the supplied classes, or {@code null}
* if both {@code c1} and {@code c2} are null.
- *
- * @since 3.01 (derived from 3.00)
*/
public static Class<?> findCommonClass(Class<?> c1, Class<?> c2) {
if (c1 == null) return c2;
@@ -491,8 +477,6 @@ next: for (final Class<?> candidat
* @param c2 The second class.
* @return The interfaces common to both classes, or an empty set if none.
* Callers can freely modify the returned set.
- *
- * @since 3.01
*/
public static Set<Class<?>> findCommonInterfaces(final Class<?> c1,
final Class<?> c2) {
final Set<Class<?>> interfaces = getAllInterfaces(c1);
@@ -527,8 +511,6 @@ next: for (final Class<?> candidat
* @param base The parent of all interfaces to check.
* @return {@code true} if both objects implement the same set of interfaces,
* considering only sub-interfaces of {@code base}.
- *
- * @since 3.01 (derived from 2.5)
*/
public static boolean implementSameInterfaces(final Class<?> object1, final Class<?>
object2, final Class<?> base) {
if (object1 == object2) {
@@ -635,8 +617,6 @@ compare:for (int i=0; i<c1.length; i++)
* @param type The type to be tested, or {@code null}.
* @param allowedTypes The allowed types.
* @return {@code true} if the given type is assignable to one of the allowed types.
- *
- * @since 3.12
*/
public static boolean isAssignableTo(final Class<?> type, final Class<?>...
allowedTypes) {
if (type != null) {
|