This project has retired. For details please refer to its Attic page.
WritableWriter xref
View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.giraph.types.ops.collections;
19  
20  import java.io.DataInput;
21  import java.io.DataOutput;
22  import java.io.IOException;
23  
24  /**
25   * Handler for knowing how to serialize/deserialize type T
26   *
27   * @param <T> Type of object to be serialized.
28   */
29  public interface WritableWriter<T> {
30    /**
31     * Serialize the fields of <code>value</code> to <code>out</code>.
32     *
33     * @param out <code>DataOuput</code> to serialize object into.
34     * @param value Object to serialize
35     * @throws IOException
36     */
37    void write(DataOutput out, T value) throws IOException;
38  
39    /**
40     * Deserialize the fields of object from <code>in</code>.
41     *
42     * @param in <code>DataInput</code> to deseriablize object from.
43     * @return Deserialized object.
44     * @throws IOException
45     */
46    T readFields(DataInput in) throws IOException;
47  }