/*
 * @(#)DOMOutput.java
 *
 * Copyright (c) 1996-2010 by the original authors of JHotDraw and all its
 * contributors. All rights reserved.
 *
 * You may not use, copy or modify this file, except in compliance with the 
 * license agreement you entered into with the copyright holders. For details
 * see accompanying license terms.
 */


package org.jhotdraw.xml;

import java.io.IOException;

/**
 * DOMOutput.
 * 

*


* Design Patterns * *

Abstract Factory
* {@code DOMFactory} is used by {@code DOMInput} and {@code DOMOutput} for * creating Java objects and DOM elements. * Abstract Factory: {@link DOMFactory}
* Client: {@link DOMInput}, {@link DOMOutput}. * *

Strategy
* {@code DOMFactory} is used by {@code DOMInput} and {@code DOMOutput} for * reading and writing objects. * Client: {@link DOMInput}, {@link DOMOutput}.
* Strategy: {@link DOMFactory}.
* * @author Werner Randelshofer * @version $Id: DOMOutput.java 717 2010-11-21 12:30:57Z rawcoder $ */ public interface DOMOutput { /** * Sets the doctype for the XML document. */ public void setDoctype(String doctype); /** * Adds a new element to the DOM Document and opens it. * The new element is added as a child to the current element in the DOM * document. Then it becomes the current element. * The element must be closed using closeElement. */ public void openElement(String tagName); /** * Closes the current element of the DOM Document. * The parent of the current element becomes the current element. * @exception IllegalArgumentException if the provided tagName does * not match the tag name of the element. */ public void closeElement(); /** * Adds a comment to the current element of the DOM Document. */ public void addComment(String comment); /** * Adds a text to current element of the DOM Document. * Note: Multiple consecutives texts will be merged. */ public void addText(String text); /** * Adds an attribute to current element of the DOM Document. */ public void addAttribute(String name, String value); /** * Adds an attribute to current element of the DOM Document if it is * different from the default value. */ public void addAttribute(String name, String value, String defaultValue); /** * Adds an attribute to current element of the DOM Document. */ public void addAttribute(String name, int value); /** * Adds an attribute to current element of the DOM Document if it is * different from the default value. */ public void addAttribute(String name, int value, int defaultValue); /** * Adds an attribute to current element of the DOM Document. */ public void addAttribute(String name, boolean value); /** * Adds an attribute to current element of the DOM Document if it is * different from the default value. */ public void addAttribute(String name, boolean value, boolean defaultValue); /** * Adds an attribute to current element of the DOM Document. */ public void addAttribute(String name, float value); /** * Adds an attribute to current element of the DOM Document if it is * different from the default value. */ public void addAttribute(String name, float value, float defaultValue); /** * Adds an attribute to current element of the DOM Document. */ public void addAttribute(String name, double value); /** * Adds an attribute to current element of the DOM Document if it is * different from the default value. */ public void addAttribute(String name, double value, double defaultValue); /** * Writes an object. */ public void writeObject(Object o) throws IOException; /** * Returns a prototype for the object currently being written. * This can be used, to reduce the amount of data written to DOMOutput. * For example, by not writing object attributes, which have the same values * as the prototype. */ public Object getPrototype(); }

Ads help maintain this website.