com.theoryinpractise.halbuilder.api.RepresentationWriter Maven / Gradle / Ivy

package com.theoryinpractise.halbuilder.api;

import java.io.Writer;
import java.net.URI;
import java.util.Set;

/**
 * A RepresentationWriter takes a ReadableRepresentation and renders it to the provided Writer, returning an
 * Optional value.
 * @param  A class to return.
 */
public interface RepresentationWriter {

    /**
     * Writes the representation to the provided Writer.
     * @param representation The representation to write
     * @param flags A set of URI based flags to provide configuration to renderers
     * @param writer The Writer to write to
     */
    void write(ReadableRepresentation representation, Set flags, Writer writer);
}