001/*
002Copyright (c) 2011+, HL7, Inc
003All rights reserved.
004
005Redistribution and use in source and binary forms, with or without modification, 
006are permitted provided that the following conditions are met:
007
008 * Redistributions of source code must retain the above copyright notice, this 
009   list of conditions and the following disclaimer.
010 * Redistributions in binary form must reproduce the above copyright notice, 
011   this list of conditions and the following disclaimer in the documentation 
012   and/or other materials provided with the distribution.
013 * Neither the name of HL7 nor the names of its contributors may be used to 
014   endorse or promote products derived from this software without specific 
015   prior written permission.
016
017THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
018ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
019WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
020IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
021INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
022NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
023PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
024WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
025ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
026POSSIBILITY OF SUCH DAMAGE.
027
028*/
029package org.hl7.fhir.utilities.xml;
030
031import java.io.IOException;
032
033/**
034 * Generalize 
035 * @author dennisn
036 */
037public interface IXMLWriter {
038        
039  public abstract void start() throws IOException;
040  public abstract void end() throws IOException;
041
042        public abstract void attribute(String namespace, String name, String value, boolean onlyIfNotEmpty) throws IOException;
043        public abstract void attribute(String namespace, String name, String value) throws IOException;
044        public abstract void attribute(String name, String value, boolean onlyIfNotEmpty) throws IOException;
045        public abstract void attribute(String name, String value) throws IOException;
046        public abstract void attributeNoLines(String name, String value) throws IOException;
047
048        public abstract boolean namespaceDefined(String namespace);
049        public abstract boolean abbreviationDefined(String abbreviation);
050        public abstract String getDefaultNamespace();
051        public abstract void namespace(String namespace) throws IOException;
052        public abstract void setDefaultNamespace(String namespace) throws IOException;
053        public abstract void namespace(String namespace, String abbreviation) throws IOException;
054        
055        public abstract void comment(String comment, boolean doPretty) throws IOException;
056
057  public abstract void enter(String name) throws IOException;
058        public abstract void enter(String namespace, String name) throws IOException;
059        public abstract void enter(String namespace, String name, String comment) throws IOException;
060        
061  public abstract void exit() throws IOException;
062        public abstract void exit(String name) throws IOException;
063        public abstract void exit(String namespace, String name) throws IOException;
064        public abstract void exitToLevel(int count) throws IOException;
065
066
067        public abstract void element(String namespace, String name, String content,     boolean onlyIfNotEmpty) throws IOException;
068        public abstract void element(String namespace, String name, String content,     String comment) throws IOException;
069        public abstract void element(String namespace, String name, String content)     throws IOException;
070        public abstract void element(String name, String content,       boolean onlyIfNotEmpty) throws IOException;
071        public abstract void element(String name, String content)       throws IOException;
072        public abstract void element(String name) throws IOException;
073
074        public abstract void text(String content) throws IOException;
075        public abstract void text(String content, boolean dontEscape) throws IOException;
076
077        public abstract void cData(String text) throws IOException;
078
079        public abstract void writeBytes(byte[] bytes) throws IOException;
080
081        public abstract boolean isPretty() throws IOException;
082        public abstract void setPretty(boolean pretty) throws IOException;
083
084        /**
085         * Start comment inserts a <!-- in the stream, but allows the user to 
086         * go on creating xml content as usual, with proper formatting applied etc.
087         * Any comments inserted inside a comment will be terminated with -- > instead of -->
088         * so the comment doesn't close prematurely.
089         * @throws IOException 
090         */
091        public abstract void startCommentBlock() throws IOException;
092        public abstract void endCommentBlock() throws IOException;
093        public abstract void escapedText(String content) throws IOException;
094        
095        // this is only implemented by an implementation that is producing an xhtml representation, and is able to render elements as hyperlinks 
096  public abstract void link(String href);
097  
098}