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