-
Notifications
You must be signed in to change notification settings - Fork 22
/
XMLWriter.java
94 lines (82 loc) · 3.01 KB
/
XMLWriter.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
package org.apache.maven.shared.utils.xml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
/**
* Interface for tools writing XML files.
* XMLWriters are not thread safe and must not be accessed concurrently.
*/
public interface XMLWriter
{
/**
* Sets the encoding of the document.
* If not set, UTF-8 is used.
*
* @param encoding the encoding
* @throws IllegalStateException if the generation of the document has already started
*/
void setEncoding( String encoding );
/**
* Sets the DOCTYPE of the document.
*
* @param docType the docType
* @throws IllegalStateException if the generation of the document has already started
*/
void setDocType( String docType );
/**
* Start an XML Element tag.
*
* @param name the name of the tag
* @throws IOException if starting the element fails
*/
void startElement( String name ) throws IOException;
/**
* Add a XML attribute to the current XML Element.
* This method must get called immediately after {@link #startElement(String)}.
*
* @param key The key of the attribute.
* @param value The value of the attribute.
* @throws IllegalStateException if no element tag is currently in process
* @throws IOException if adding the attribute fails.
*/
void addAttribute( String key, String value ) throws IOException;
/**
* Add text to the current element tag.
* This performs XML escaping to guarantee well-formed content.
*
* @param text The text which should be written.
* @throws IllegalStateException if no element tag got started yet
* @throws IOException if writing the text fails.
*/
void writeText( String text ) throws IOException;
/**
* Add preformatted markup to the current element tag.
*
* @param text the text which should be written
* @throws IllegalStateException if no element tag is started yet
* @throws IOException if writing the markup fails
*/
void writeMarkup( String text ) throws IOException;
/**
* End the previously opened element.
* @see #startElement(String)
* @throws IOException if ending the element fails.
*/
void endElement() throws IOException;
}