net.vectorpublish.desktop.vp.api.io.DocumentWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of API Show documentation

The newest version!

/*
 * Copyright (c) 2016, Peter Rader. All rights reserved.
 *  ___ ___               __                 ______         __     __  __         __
 * |   |   |.-----..----.|  |_ .-----..----.|   __ \.--.--.|  |--.|  ||__|.-----.|  |--.
 * |   |   ||  -__||  __||   _||  _  ||   _||    __/|  |  ||  _  ||  ||  ||__ --||     |
 *  \_____/ |_____||____||____||_____||__|  |___|   |_____||_____||__||__||_____||__|__|
 *
 * http://www.gnu.org/licenses/gpl-3.0.html
 */
package net.vectorpublish.desktop.vp.api.io;

import java.io.File;
import java.io.IOException;

import net.vectorpublish.desktop.vp.api.vpd.DocumentNode;

/**
 * A document writer to store documents.
 */
public interface DocumentWriter {
	/**
	 * Writes a {@link DocumentNode} to a {@link File}.
	 *
	 * @param outputFile
	 *            The file, never null.
	 * @param doc
	 *            The {@link DocumentNode}, never null.
	 * @throws IOException
	 *             If the file could not be written.
	 */
	void write(File outputFile, DocumentNode doc) throws IOException;
}