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.LongCollection;
23  
24  /**
25   * Adapts an {@link LongCollection LongCollection}
26   * to the {@link java.util.Collection Collection}
27   * interface.
28   * <p />
29   * This implementation delegates most methods
30   * to the provided {@link LongCollection LongCollection} 
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 LongCollectionCollection extends AbstractLongCollectionCollection implements Serializable {
38      
39      /**
40       * Create a {@link Collection Collection} wrapping
41       * the specified {@link LongCollection LongCollection}.  When
42       * the given <i>collection</i> is <code>null</code>,
43       * returns <code>null</code>.
44       * 
45       * @param collection the (possibly <code>null</code>) 
46       *        {@link LongCollection LongCollection} to wrap
47       * @return a {@link Collection Collection} wrapping the given 
48       *         <i>collection</i>, or <code>null</code> when <i>collection</i> is
49       *         <code>null</code>.
50       */
51      public static Collection wrap(LongCollection collection) {
52          if(null == collection) {
53              return null;
54          } else if(collection instanceof Serializable) {
55              return new LongCollectionCollection(collection);
56          } else {
57              return new NonSerializableLongCollectionCollection(collection);
58          }
59      }
60      
61      /**
62       * Creates a {@link Collection Collection} wrapping
63       * the specified {@link LongCollection LongCollection}.
64       * @see #wrap
65       */
66      public LongCollectionCollection(LongCollection collection) {
67          _collection = collection;
68      }
69      
70  
71      protected LongCollection getLongCollection() {
72          return _collection;
73      }
74          
75      private LongCollection _collection = null;
76  }