com.github.libxjava.io.ISerialiser Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of libxjava-cdc Show documentation

Lib-Cross-Java for the Connected Device Configuration v1.1.2

The newest version!

/*
 * libxjava -- utility library for cross-Java-platform development
 *             Lib-Cross-Java CDC
 *
 * Copyright (c) 2010 Marcel Patzlaff ([email protected])
 *
 * This library is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see .
 */

package com.github.libxjava.io;

import java.io.DataOutput;
import java.io.IOException;
import java.io.OutputStream;


/**
 * This interface defines write methods for a primitive serialiser.
 * 
 * @author Marcel Patzlaff
 * @version libxjava-cdc - 0.3
 */
public interface ISerialiser extends DataOutput {
    /**
     * Clears the internal serialisation graphs and flushes also
     * the underlying outputstream.
     * 
     * This method should be called to finish a serialisation process and
     * to reuse this instance for further serialisations.
     * 
     * @throws IOException  thrown from {@link OutputStream#flush()}
     */
    void flush() throws IOException;
    
    /**
     * Writes the given Object into this serialiser.
     * Consult {@link BinarySerialiserConstants} for further information!
     * 
     * @param o             the Object to write.
     * @throws IOException  if problems occur while writing data
     */
    void writeObject(Object o) throws IOException;
}