jetbrains.buildServer.util
Class XmlUtil

java.lang.Object
  jetbrains.buildServer.util.XmlUtil

public class XmlUtil
extends java.lang.Object

Some XML-related utilities

Author:

kir

Field Summary

static java.lang.String

PARAMETER_ELEMENT_NAME Name of element that is used to save parameter by writeParameter(org.jdom.Element, String, String)

Constructor Summary

XmlUtil()

Method Summary

static org.jdom.Element	from_s(java.lang.String xmlString) Simple helper method to parse XML and return root JDOM element.
static boolean	isSecureParameter(java.lang.String parameterName) Returns true if the property is secure, i.e.
static com.intellij.openapi.util.Pair<java.lang.String,java.lang.String>	readParameter(org.jdom.Element paramElement) Reads single parameter from specified parameter element
static java.util.Map<java.lang.String,java.lang.String>	readParameters(org.jdom.Element parametersElement)
static void	saveDocument(org.jdom.Document document, java.io.OutputStream os)
static java.lang.String	to_s(org.jdom.Element el) Simple helper method to format JDOM element as a String
static org.jdom.Element	writeParameter(org.jdom.Element parentElement, java.lang.String name, java.lang.String value) Write param tag under parentElement with name 'name' and value 'value' Parameter element name is PARAMETER_ELEMENT_NAME.
static void	writeParameters(org.jdom.Element parentElement, java.util.Map<java.lang.String,java.lang.String> params)

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_ELEMENT_NAME

public static final java.lang.String PARAMETER_ELEMENT_NAME

Name of element that is used to save parameter by writeParameter(org.jdom.Element, String, String)

Since:

6.0

See Also:

Constant Field Values

Constructor Detail

XmlUtil

public XmlUtil()

Method Detail

saveDocument

public static void saveDocument(org.jdom.Document document,
                                java.io.OutputStream os)
                         throws java.io.IOException

Throws:

java.io.IOException

isSecureParameter

public static boolean isSecureParameter(java.lang.String parameterName)

Returns true if the property is secure, i.e. its value should be scrambled when property persisted.

Parameters:

propertyName - property name.

Returns:

true if property value should be scrambled.

writeParameter

public static org.jdom.Element writeParameter(org.jdom.Element parentElement,
                                              java.lang.String name,
                                              java.lang.String value)

Write param tag under parentElement with name 'name' and value 'value' Parameter element name is PARAMETER_ELEMENT_NAME.

Parameters:

name - name of parameter

parentElement - parent element for param tag

value - value to be saved in param tag. If contains LF, value will be saved as CDATA

Returns:

created parameter element

readParameter

@NotNull
public static com.intellij.openapi.util.Pair<java.lang.String,java.lang.String> readParameter(@NotNull
                                                                                                      org.jdom.Element paramElement)

Reads single parameter from specified parameter element

Parameters:

paramElement - parameter element, must have name attribute

Returns:

name and value

writeParameters

public static void writeParameters(org.jdom.Element parentElement,
                                   java.util.Map<java.lang.String,java.lang.String> params)

readParameters

@NotNull
public static java.util.Map<java.lang.String,java.lang.String> readParameters(@NotNull
                                                                                      org.jdom.Element parametersElement)

to_s

public static java.lang.String to_s(org.jdom.Element el)

Simple helper method to format JDOM element as a String

Parameters:

el - element to format

Returns:

formatted XML

Since:

4.5

from_s

public static org.jdom.Element from_s(java.lang.String xmlString)

Simple helper method to parse XML and return root JDOM element. Upon any error, throws RuntimeException.

Parameters:

xmlString - XML to parse

Returns:

root JDOM element for the XML string

Since:

5.0