com.swiftmq.tools.dump.Dumpable Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 IIT Software GmbH
 *
 * IIT Software GmbH licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.swiftmq.tools.dump;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

/**
 * Interface for objects which should be dumpable via the Dumpalizer.
 *
 * @author Andreas Mueller, IIT GmbH
 * @version 1.0
 * @see Dumpalizer
 */
public interface Dumpable {
    /**
     * Returns a unique dump id for this object.
     *
     * @return unique dump id
     */
    public int getDumpId();

    /**
     * Write the content of this object to the stream.
     *
     * @param out output stream
     * @throws IOException if an error occurs
     */
    public void writeContent(DataOutput out)
            throws IOException;

    /**
     * Read the content of this object from the stream.
     *
     * @param in input stream
     * @throws IOException if an error occurs
     */
    public void readContent(DataInput in)
            throws IOException;
}