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 an {@link org.apache.commons.collections.primitives.BooleanCollection
26   * BooleanCollection} to the {@link java.util.Collection Collection} interface.
27   * <p />
28   * This implementation delegates most methods to the provided {@link
29   * org.apache.commons.collections.primitives.BooleanCollection
30   * BooleanCollection} implementation in the "obvious" way.
31   * 
32   * @since Commons Primitives 1.1
33   * @version $Revision: 480462 $ $Date: 2006-11-29 03:15:00 -0500 (Wed, 29 Nov 2006) $
34   */
35  final public class BooleanCollectionCollection extends
36          AbstractBooleanCollectionCollection implements Serializable
37  {
38      
39      /**
40       * Create a {@link java.util.Collection Collection} wrapping the specified
41       * {@link org.apache.commons.collections.primitives.BooleanCollection
42       * BooleanCollection}.  When the given <i>collection</i> is <code>null
43       * </code>, returns <code>null</code>.
44       * 
45       * @param collection the (possibly <code>null</code>) 
46       *        {@link org.apache.commons.collections.primitives.BooleanCollection
47       *        BooleanCollection} to wrap
48       * @return a {@link java.util.Collection Collection} wrapping the given
49       *         <i>collection</i>, or <code>null</code> when <i>collection</i> is
50       *         <code>null</code>.
51       */
52      public static Collection wrap(BooleanCollection collection) {
53          if(null == collection) {
54              return null;
55          } else if(collection instanceof Serializable) {
56              return new BooleanCollectionCollection(collection);
57          } else {
58              return new NonSerializableBooleanCollectionCollection(collection);
59          }
60      }
61      
62      /**
63       * Creates a {@link java.util.Collection Collection} wrapping the specified
64       * {@link org.apache.commons.collections.primitives.BooleanCollection
65       * BooleanCollection}.
66       * @see #wrap
67       */
68      public BooleanCollectionCollection(BooleanCollection collection) {
69          _collection = collection;
70      }
71      
72  
73      protected BooleanCollection getBooleanCollection() {
74          return _collection;
75      }
76          
77      private BooleanCollection _collection = null;
78  }