View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.collections.primitives.adapters;
18  
19  import java.io.Serializable;
20  import java.util.Collection;
21  
22  import org.apache.commons.collections.primitives.BooleanCollection;
23  
24  /**
25   * Adapts a {@link Boolean Boolean}-valued {@link java.util.Collection
26   * Collection} to the {@link
27   * org.apache.commons.collections.primitives.BooleanCollection
28   * BooleanCollection} interface.
29   * <p/>
30   * This implementation delegates most methods to the provided
31   * {@link java.util.Collection Collection} implementation in the "obvious" way.
32   * 
33   * @since Commons Primitives 1.1
34   * @version $Revision: 480462 $ $Date: 2006-11-29 03:15:00 -0500 (Wed, 29 Nov 2006) $
35   */
36  final public class CollectionBooleanCollection
37          extends AbstractCollectionBooleanCollection implements Serializable {
38      /**
39       * Create an {@link
40       * org.apache.commons.collections.primitives.BooleanCollection
41       * BooleanCollection} wrapping the specified {@link java.util.Collection
42       * Collection}.  When the given <i>collection</i> is <code>null</code>,
43       * returns <code>null</code>.
44       * 
45       * @param collection the (possibly <code>null</code>) {@link
46       * java.util.Collection} to wrap
47       * @return an {@link
48       * org.apache.commons.collections.primitives.BooleanCollection
49       * BooleanCollection} wrapping the given <i>collection</i>, or <code>null
50       * </code> when <i>collection</i> is <code>null</code>.
51       */
52      public static BooleanCollection wrap(Collection collection) {
53          if(null == collection) {
54              return null;
55          } else if(collection instanceof Serializable) {
56              return new CollectionBooleanCollection(collection);
57          } else {
58              return new NonSerializableCollectionBooleanCollection(collection);
59          }
60      }
61  
62      /**
63       * Creates an {@link
64       * org.apache.commons.collections.primitives.BooleanCollection
65       * BooleanCollection} wrapping the specified {@link java.util.Collection
66       * Collection}.
67       * @see #wrap
68       */
69      public CollectionBooleanCollection(Collection collection) {
70          _collection = collection;
71      }
72      
73      protected Collection getCollection() {
74          return _collection;
75      }
76   
77      private Collection _collection = null;         
78  }