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.set;
18  
19  import java.io.IOException;
20  import java.io.ObjectInputStream;
21  import java.io.ObjectOutputStream;
22  import java.io.Serializable;
23  import java.util.Collection;
24  import java.util.Set;
25  
26  /**
27   * Serializable subclass of AbstractSetDecorator.
28   *
29   * @since 3.1
30   * @version $Id: AbstractSerializableSetDecorator.java 1429905 2013-01-07 17:15:14Z ggregory $
31   */
32  public abstract class AbstractSerializableSetDecorator<E>
33          extends AbstractSetDecorator<E>
34          implements Serializable {
35  
36      /** Serialization version */
37      private static final long serialVersionUID = 1229469966212206107L;
38  
39      /**
40       * Constructor.
41       * 
42       * @param set  the list to decorate, must not be null
43       * @throws IllegalArgumentException if set is null
44       */
45      protected AbstractSerializableSetDecorator(final Set<E> set) {
46          super(set);
47      }
48  
49      //-----------------------------------------------------------------------
50      /**
51       * Write the set out using a custom routine.
52       * 
53       * @param out  the output stream
54       * @throws IOException
55       */
56      private void writeObject(final ObjectOutputStream out) throws IOException {
57          out.defaultWriteObject();
58          out.writeObject(collection);
59      }
60  
61      /**
62       * Read the set in using a custom routine.
63       * 
64       * @param in  the input stream
65       * @throws IOException
66       * @throws ClassNotFoundException
67       */
68      @SuppressWarnings("unchecked")
69      private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
70          in.defaultReadObject();
71          collection = (Collection<E>) in.readObject();
72      }
73  
74  }