Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id DAB6CC43E for ; Tue, 3 Jul 2012 20:49:33 +0000 (UTC) Received: (qmail 87113 invoked by uid 500); 3 Jul 2012 20:49:33 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 87048 invoked by uid 500); 3 Jul 2012 20:49:33 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 87040 invoked by uid 99); 3 Jul 2012 20:49:33 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Jul 2012 20:49:33 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 03 Jul 2012 20:49:29 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 92BF62388847 for ; Tue, 3 Jul 2012 20:49:07 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1356933 - /commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/ Date: Tue, 03 Jul 2012 20:49:05 -0000 To: commits@commons.apache.org From: tn@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120703204907.92BF62388847@eris.apache.org> Author: tn Date: Tue Jul 3 20:49:03 2012 New Revision: 1356933 URL: http://svn.apache.org/viewvc?rev=1356933&view=rev Log: Cleanup of collection package. Added: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package-info.java - copied, changed from r1356878, commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package.html Removed: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package.html Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractCollectionDecorator.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractUntypedCollectionDecorator.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/CompositeCollection.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/PredicatedCollection.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/SynchronizedCollection.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/TransformedCollection.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableCollection.java Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractCollectionDecorator.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractCollectionDecorator.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractCollectionDecorator.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractCollectionDecorator.java Tue Jul 3 20:49:03 2012 @@ -37,10 +37,7 @@ import java.util.Iterator; * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne - * @author Paul Jack + * @version $Id$ */ public abstract class AbstractCollectionDecorator implements Collection, Serializable { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractUntypedCollectionDecorator.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractUntypedCollectionDecorator.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractUntypedCollectionDecorator.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/AbstractUntypedCollectionDecorator.java Tue Jul 3 20:49:03 2012 @@ -38,12 +38,8 @@ import java.util.Collection; * * @param the type of the elements in the decorated collection * @param the element type of the Collection implementation - * @since Commons Collections 5 - * @version $Revision$ - * - * @author Stephen Colebourne - * @author Paul Jack - * @author Matt Benson + * @since Commons Collections 4.0 + * @version $Id$ */ public abstract class AbstractUntypedCollectionDecorator implements Collection, Serializable { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/CompositeCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/CompositeCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/CompositeCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/CompositeCollection.java Tue Jul 3 20:49:03 2012 @@ -37,11 +37,7 @@ import org.apache.commons.collections.li * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Brian McCallister - * @author Stephen Colebourne - * @author Phil Steitz + * @version $Id$ */ public class CompositeCollection implements Collection, Serializable { @@ -190,6 +186,7 @@ public class CompositeCollection impl * Returns an object array, populating the supplied array if possible. * See Collection interface for full details. * + * @param the type of the elements in the collection * @param array the array to use, populating if possible * @return an array of all the elements in the collection */ @@ -220,7 +217,7 @@ public class CompositeCollection impl * unless a CollectionMutator strategy is specified. * * @param obj the object to add - * @return true if the collection was modified + * @return {@code true} if the collection was modified * @throws UnsupportedOperationException if CollectionMutator hasn't been set * @throws UnsupportedOperationException if add is unsupported * @throws ClassCastException if the object cannot be added due to its type @@ -464,7 +461,9 @@ public class CompositeCollection impl * @throws NullPointerException if the object cannot be added because its null * @throws IllegalArgumentException if the object cannot be added */ - public boolean addAll(CompositeCollection composite, List> collections, Collection coll); + public boolean addAll(CompositeCollection composite, + List> collections, + Collection coll); /** * Called when an object is to be removed to the composite. Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/PredicatedCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/PredicatedCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/PredicatedCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/PredicatedCollection.java Tue Jul 3 20:49:03 2012 @@ -21,7 +21,7 @@ import java.util.Collection; import org.apache.commons.collections.Predicate; /** - * Decorates another Collection to validate that additions + * Decorates another {@link Collection} to validate that additions * match a specified predicate. *

* This collection exists to provide validation for the decorated collection. @@ -35,10 +35,7 @@ import org.apache.commons.collections.Pr * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne - * @author Paul Jack + * @version $Id$ */ public class PredicatedCollection extends AbstractCollectionDecorator { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/SynchronizedCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/SynchronizedCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/SynchronizedCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/SynchronizedCollection.java Tue Jul 3 20:49:03 2012 @@ -21,7 +21,7 @@ import java.util.Collection; import java.util.Iterator; /** - * Decorates another Collection to synchronize its behaviour + * Decorates another {@link Collection} to synchronize its behaviour * for a multi-threaded environment. *

* Iterators must be manually synchronized: @@ -36,9 +36,7 @@ import java.util.Iterator; * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public class SynchronizedCollection implements Collection, Serializable { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/TransformedCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/TransformedCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/TransformedCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/TransformedCollection.java Tue Jul 3 20:49:03 2012 @@ -23,7 +23,7 @@ import java.util.List; import org.apache.commons.collections.Transformer; /** - * Decorates another Collection to transform objects that are added. + * Decorates another {@link Collection} to transform objects that are added. *

* The add methods are affected by this class. * Thus objects must be removed or searched for using their transformed form. @@ -34,9 +34,7 @@ import org.apache.commons.collections.Tr * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public class TransformedCollection extends AbstractCollectionDecorator { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableBoundedCollection.java Tue Jul 3 20:49:03 2012 @@ -23,8 +23,8 @@ import org.apache.commons.collections.Bo import org.apache.commons.collections.iterators.UnmodifiableIterator; /** - * UnmodifiableBoundedCollection decorates another - * BoundedCollection to ensure it can't be altered. + * {@link UnmodifiableBoundedCollection} decorates another + * {@link BoundedCollection} to ensure it can't be altered. *

* If a BoundedCollection is first wrapped in some other collection decorator, * such as synchronized or predicated, the BoundedCollection methods are no @@ -37,9 +37,7 @@ import org.apache.commons.collections.it * Attempts to modify it will result in an UnsupportedOperationException. * * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public final class UnmodifiableBoundedCollection extends AbstractCollectionDecorator implements BoundedCollection { Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableCollection.java URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableCollection.java?rev=1356933&r1=1356932&r2=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableCollection.java (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/UnmodifiableCollection.java Tue Jul 3 20:49:03 2012 @@ -23,7 +23,7 @@ import org.apache.commons.collections.Un import org.apache.commons.collections.iterators.UnmodifiableIterator; /** - * Decorates another Collection to ensure it can't be altered. + * Decorates another {@link Collection} to ensure it can't be altered. *

* This class is Serializable from Commons Collections 3.1. *

@@ -31,9 +31,7 @@ import org.apache.commons.collections.it * * @param the type of the elements in the collection * @since Commons Collections 3.0 - * @version $Revision$ - * - * @author Stephen Colebourne + * @version $Id$ */ public final class UnmodifiableCollection extends AbstractCollectionDecorator Copied: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package-info.java (from r1356878, commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package.html) URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package-info.java?p2=commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package-info.java&p1=commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package.html&r1=1356878&r2=1356933&rev=1356933&view=diff ============================================================================== --- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package.html (original) +++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/collection/package-info.java Tue Jul 3 20:49:03 2012 @@ -1,36 +1,36 @@ - - - -

-This package contains implementations of the -{@link java.util.Collection Collection} interface. -

-The following implementations are provided in the package: -

    -
  • CompositeCollection - a collection that combines multiple collections into one -
-The following decorators are provided in the package: -
    -
  • Synchronized - synchronizes method access for multi-threaded environments -
  • Unmodifiable - ensures the collection cannot be altered -
  • Predicated - ensures that only elements that are valid according to a predicate can be added -
  • Typed - ensures that only elements that are of a specific type can be added -
  • Transformed - transforms elements as they are added -
- - +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * 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. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * This package contains implementations of the + * {@link java.util.Collection Collection} interface. + *

+ * The following implementations are provided in the package: + *

    + *
  • CompositeCollection - a collection that combines multiple collections into one + *
+ * The following decorators are provided in the package: + *
    + *
  • Synchronized - synchronizes method access for multi-threaded environments + *
  • Unmodifiable - ensures the collection cannot be altered + *
  • Predicated - ensures that only elements that are valid according to a predicate can be added + *
  • Typed - ensures that only elements that are of a specific type can be added + *
  • Transformed - transforms elements as they are added + *
+ * + * @version $Id$ + */ +package org.apache.commons.collections.collection;