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