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.collections4.list;
18  
19  import java.io.IOException;
20  import java.io.ObjectInputStream;
21  import java.io.ObjectOutputStream;
22  import java.util.Collection;
23  import java.util.List;
24  
25  /**
26   * Serializable subclass of AbstractListDecorator.
27   *
28   * @since 3.1
29   */
30  public abstract class AbstractSerializableListDecorator<E>
31          extends AbstractListDecorator<E> {
32  
33      /** Serialization version */
34      private static final long serialVersionUID = 2684959196747496299L;
35  
36      /**
37       * Constructor that wraps (not copies).
38       *
39       * @param list  the list to decorate, must not be null
40       * @throws NullPointerException if list is null
41       */
42      protected AbstractSerializableListDecorator(final List<E> list) {
43          super(list);
44      }
45  
46      /**
47       * Read the list in using a custom routine.
48       *
49       * @param in  the input stream
50       * @throws IOException if an error occurs while reading from the stream
51       * @throws ClassNotFoundException if an object read from the stream can not be loaded
52       */
53      @SuppressWarnings("unchecked")
54      private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
55          in.defaultReadObject();
56          setCollection((Collection<E>) in.readObject());
57      }
58  
59      /**
60       * Write the list out using a custom routine.
61       *
62       * @param out  the output stream
63       * @throws IOException if an error occurs while writing to the stream
64       */
65      private void writeObject(final ObjectOutputStream out) throws IOException {
66          out.defaultWriteObject();
67          out.writeObject(decorated());
68      }
69  
70  }