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