[120] | 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 | |
---|
| 19 | package org.apache.hadoop.io.serializer; |
---|
| 20 | |
---|
| 21 | import java.io.IOException; |
---|
| 22 | import java.io.OutputStream; |
---|
| 23 | |
---|
| 24 | /** |
---|
| 25 | * <p> |
---|
| 26 | * Provides a facility for serializing objects of type <T> to an |
---|
| 27 | * {@link OutputStream}. |
---|
| 28 | * </p> |
---|
| 29 | * |
---|
| 30 | * <p> |
---|
| 31 | * Serializers are stateful, but must not buffer the output since |
---|
| 32 | * other producers may write to the output between calls to |
---|
| 33 | * {@link #serialize(Object)}. |
---|
| 34 | * </p> |
---|
| 35 | * @param <T> |
---|
| 36 | */ |
---|
| 37 | public interface Serializer<T> { |
---|
| 38 | /** |
---|
| 39 | * <p>Prepare the serializer for writing.</p> |
---|
| 40 | */ |
---|
| 41 | void open(OutputStream out) throws IOException; |
---|
| 42 | |
---|
| 43 | /** |
---|
| 44 | * <p>Serialize <code>t</code> to the underlying output stream.</p> |
---|
| 45 | */ |
---|
| 46 | void serialize(T t) throws IOException; |
---|
| 47 | |
---|
| 48 | /** |
---|
| 49 | * <p>Close the underlying output stream and clear up any resources.</p> |
---|
| 50 | */ |
---|
| 51 | void close() throws IOException; |
---|
| 52 | } |
---|