com.github.jferard.fastods.util

Class XMLUtil

java.lang.Object

com.github.jferard.fastods.util.XMLUtil

public class XMLUtil
extends Object

An util for writing XML representation.

Author:

Julien Férard

Field Summary

Fields

Modifier and Type	Field and Description
static char	SPACE_CHAR A space char for append
static String	XML_PROLOG the usual preamble

Method Summary

Modifier and Type	Method and Description
void	appendAttribute(Appendable appendable, CharSequence attrName, AttributeValue attrValue) Append a space, then a new element to the appendable element, the name of the element is attrName and the value is attrValue.
void	appendAttribute(Appendable appendable, CharSequence attrName, boolean attrValue) Append a new element to the appendable element, the name of the element is attrName and the value is the boolean attrValue.
void	appendAttribute(Appendable appendable, CharSequence attrName, CharSequence attrValue) Append a space, then a new element to the appendable element, the name of the element is attrName and the value is attrValue.
void	appendAttribute(Appendable appendable, CharSequence attrName, int attrValue) Append a new element to the appendable element, the name of the element is attrName and the value is attrValue.
void	appendAttribute(Appendable appendable, CharSequence attrName, List<?> attrs, String sep) Append a space, then a new element to the appendable element, the name of the element is attrName and the value is a list.
void	appendEAttribute(Appendable appendable, CharSequence attrName, String attrRawValue) Escape then append.
void	appendTag(Appendable appendable, CharSequence tagName, String content) Append a content inside a tag
static XMLUtil	create()
String	escapeXMLAttribute(String s) Escape an XML attribute
String	escapeXMLContent(String s) Escape an XML content
String	formatNegTimeInterval(long years, long months, long days, long hours, long minutes, double seconds) XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'" All parameters must be positive
String	formatTimeInterval(long milliseconds) XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'"
String	formatTimeInterval(long years, long months, long days, long hours, long minutes, double seconds) XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'" All parameters must be positive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XML_PROLOG

public static final String XML_PROLOG

the usual preamble

See Also:

Constant Field Values

SPACE_CHAR

public static final char SPACE_CHAR

A space char for append

See Also:

Constant Field Values

Method Detail

create

public static XMLUtil create()

Returns:

a new default xml util

appendEAttribute

public void appendEAttribute(Appendable appendable,
                             CharSequence attrName,
                             String attrRawValue)
                      throws IOException

Escape then append.

Append a space and new element to the appendable element, the name of the element is attrName and the value is attrRawValue. The will be escaped if necessary

Parameters:

appendable - The StringBuilder to which the new element should be added.

attrName - The new element name

attrRawValue - The value of the element

Throws:

IOException - If an I/O error occurs

appendAttribute

public void appendAttribute(Appendable appendable,
                            CharSequence attrName,
                            boolean attrValue)
                     throws IOException

Append a new element to the appendable element, the name of the element is attrName and the value is the boolean attrValue.

Parameters:

appendable - The StringBuilder to which the new element should be added.

attrName - The new element name

attrValue - The value of the element

Throws:

IOException - If an I/O error occurs

appendAttribute

public void appendAttribute(Appendable appendable,
                            CharSequence attrName,
                            int attrValue)
                     throws IOException

Append a new element to the appendable element, the name of the element is attrName and the value is attrValue.

Parameters:

appendable - The StringBuilder to which the new element should be added.

attrName - The new element name

attrValue - The value of the element

Throws:

IOException - If an I/O error occurs

appendAttribute

public void appendAttribute(Appendable appendable,
                            CharSequence attrName,
                            CharSequence attrValue)
                     throws IOException

Append a space, then a new element to the appendable element, the name of the element is attrName and the value is attrValue. The value won't be escaped.

Parameters:

appendable - where to write

attrName - the name of the attribute

attrValue - escaped attribute

Throws:

IOException - If an I/O error occurs

appendAttribute

public void appendAttribute(Appendable appendable,
                            CharSequence attrName,
                            AttributeValue attrValue)
                     throws IOException

Append a space, then a new element to the appendable element, the name of the element is attrName and the value is attrValue. The value won't be escaped.

Parameters:

appendable - where to write

attrName - the name of the attribute

attrValue - escaped attribute

Throws:

IOException - If an I/O error occurs

appendAttribute

public void appendAttribute(Appendable appendable,
                            CharSequence attrName,
                            List<?> attrs,
                            String sep)
                     throws IOException

Append a space, then a new element to the appendable element, the name of the element is attrName and the value is a list. The value won't be escaped.

Parameters:

appendable - where to write

attrName - the name of the attribute

attrs - list of attributes

sep - the separator

Throws:

IOException - If an I/O error occurs

appendTag

public void appendTag(Appendable appendable,
                      CharSequence tagName,
                      String content)
               throws IOException

Append a content inside a tag

Parameters:

appendable - the destination

tagName - the tag name

content - the content

Throws:

IOException - if an I/O error occurs

escapeXMLAttribute

public String escapeXMLAttribute(String s)

Escape an XML attribute

Parameters:

s - the attribute

Returns:

the escaped attribute

escapeXMLContent

public String escapeXMLContent(String s)

Escape an XML content

Parameters:

s - the content

Returns:

the escaped content

formatTimeInterval

public String formatTimeInterval(long milliseconds)

XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'"

Parameters:

milliseconds - the interval to format in milliseconds

Returns:

the string that represents this interval

formatTimeInterval

public String formatTimeInterval(long years,
                                 long months,
                                 long days,
                                 long hours,
                                 long minutes,
                                 double seconds)

XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'"

All parameters must be positive

Parameters:

years - number of years

months - number of months

days - number of days

hours - number of hours

minutes - number of minutes

seconds - number of seconds

Returns:

the string that represents this interval

formatNegTimeInterval

public String formatNegTimeInterval(long years,
                                    long months,
                                    long days,
                                    long hours,
                                    long minutes,
                                    double seconds)

XML Schema Part 2, 3.2.6 duration "'P'yyyy'Y'MM'M'dd'DT'HH'H'mm'M'ss.SSS'S'"

All parameters must be positive

Parameters:

years - number of years

months - number of months

days - number of days

hours - number of hours

minutes - number of minutes

seconds - number of seconds

Returns:

the string that represents this interval with a negative value