io.legaldocml.io.Externalizable Maven / Gradle / Ivy

Go to download
package io.legaldocml.io;

import com.google.common.collect.ImmutableMap;

import java.io.IOException;
import java.util.function.BiConsumer;

/**
 * @author Jacques Militello
 */
public interface Externalizable {

    /**
     * The object implements the write method to save its contents by calling the methods of Output.
     *
     * @param writer the stream to write the object to
     *
     */
    void write(XmlWriter writer) throws IOException;

    /**
     * The object implements the read method to restore its contents by calling the methods of Input.
     *
     * @param reader the stream to read data from in order to restore the object
     */
    void read(XmlReader reader);

    /**
     * To read attributes.
     */
    default ImmutableMap> attributes() {
        throw new UnsupportedOperationException(getClass() + " must implement attributes()");
    }

}