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
031/*
032 * #%L
033 * HAPI FHIR - Core Library
034 * %%
035 * Copyright (C) 2014 - 2017 University Health Network
036 * %%
037 * Licensed under the Apache License, Version 2.0 (the "License");
038 * you may not use this file except in compliance with the License.
039 * You may obtain a copy of the License at
040 * 
041 *      http://www.apache.org/licenses/LICENSE-2.0
042 * 
043 * Unless required by applicable law or agreed to in writing, software
044 * distributed under the License is distributed on an "AS IS" BASIS,
045 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
046 * See the License for the specific language governing permissions and
047 * limitations under the License.
048 * #L%
049 */
050
051
052import java.io.IOException;
053
054/**
055 * Generalize 
056 * @author dennisn
057 */
058public interface IXMLWriter {
059        
060  public abstract void start() throws IOException;
061  public abstract void end() throws IOException;
062
063        public abstract void attribute(String namespace, String name, String value, boolean onlyIfNotEmpty) throws IOException;
064        public abstract void attribute(String namespace, String name, String value) throws IOException;
065        public abstract void attribute(String name, String value, boolean onlyIfNotEmpty) throws IOException;
066        public abstract void attribute(String name, String value) throws IOException;
067        public abstract void attributeNoLines(String name, String value) throws IOException;
068
069        public abstract boolean namespaceDefined(String namespace);
070        public abstract boolean abbreviationDefined(String abbreviation);
071        public abstract String getDefaultNamespace();
072        public abstract void namespace(String namespace) throws IOException;
073        public abstract void setDefaultNamespace(String namespace) throws IOException;
074        public abstract void namespace(String namespace, String abbreviation) throws IOException;
075        
076        public abstract void comment(String comment, boolean doPretty) throws IOException;
077
078  public abstract void enter(String name) throws IOException;
079        public abstract void enter(String namespace, String name) throws IOException;
080        public abstract void enter(String namespace, String name, String comment) throws IOException;
081        
082  public abstract void exit() throws IOException;
083        public abstract void exit(String name) throws IOException;
084        public abstract void exit(String namespace, String name) throws IOException;
085        public abstract void exitToLevel(int count) throws IOException;
086
087
088        public abstract void element(String namespace, String name, String content,     boolean onlyIfNotEmpty) throws IOException;
089        public abstract void element(String namespace, String name, String content,     String comment) throws IOException;
090        public abstract void element(String namespace, String name, String content)     throws IOException;
091        public abstract void element(String name, String content,       boolean onlyIfNotEmpty) throws IOException;
092        public abstract void element(String name, String content)       throws IOException;
093        public abstract void element(String name) throws IOException;
094
095        public abstract void text(String content) throws IOException;
096        public abstract void text(String content, boolean dontEscape) throws IOException;
097
098        public abstract void cData(String text) throws IOException;
099
100        public abstract void writeBytes(byte[] bytes) throws IOException;
101
102        public abstract boolean isPretty() throws IOException;
103        public abstract void setPretty(boolean pretty) throws IOException;
104
105        /**
106         * Start comment inserts a <!-- in the stream, but allows the user to 
107         * go on creating xml content as usual, with proper formatting applied etc.
108         * Any comments inserted inside a comment will be terminated with -- > instead of -->
109         * so the comment doesn't close prematurely.
110         * @throws IOException 
111         */
112        public abstract void startCommentBlock() throws IOException;
113        public abstract void endCommentBlock() throws IOException;
114        public abstract void escapedText(String content) throws IOException;
115        
116        // this is only implemented by an implementation that is producing an xhtml representation, and is able to render elements as hyperlinks 
117  public abstract void link(String href);
118  
119}