Package com.intellij.openapi.util

Class JDOMExternalizerUtil

java.lang.Object

com.intellij.openapi.util.JDOMExternalizerUtil

public class JDOMExternalizerUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JDOMExternalizerUtil()

Method Summary

Modifier and Type	Method and Description
static void	addChildren(Element parent, java.lang.String childElementName, java.util.Collection<? extends JDOMExternalizable> children)
static void	addChildrenWithValueAttribute(Element parent, java.lang.String childTagName, java.util.List<java.lang.String> attrValues)
static Element	addElementWithValueAttribute(Element parent, java.lang.String childTagName, java.lang.String attrValue) Deprecated. use writeCustomField(Element, String, String)
static java.util.List<java.lang.String>	getChildrenValueAttributes(Element parent, java.lang.String childTagName)
static java.lang.String	getFirstChildValueAttribute(Element parent, java.lang.String childTagName) Deprecated. use readCustomField(Element, String)
static java.lang.String	readCustomField(Element parent, java.lang.String tagName)
static java.lang.String	readField(Element parent, java.lang.String fieldName)
static java.lang.String	readField(Element parent, java.lang.String fieldName, java.lang.String defaultValue)
static Element	readOption(Element parent, java.lang.String fieldName)
static void	writeCustomField(Element parent, java.lang.String tagName, java.lang.String value) Adds the <{tagName} value="{value}"/> element to the parent (or just <{tagName}"/> if the value is null).
static void	writeField(Element parent, java.lang.String fieldName, java.lang.String value) Adds the <option name="{fieldName}" value="{value}"/> element to the parent.
static void	writeField(Element parent, java.lang.String fieldName, java.lang.String value, java.lang.String defaultValue) Adds the <option name="{fieldName}" value="{value}"/> element to the parent when the value differs from the default.
static Element	writeOption(Element parent, java.lang.String fieldName) Adds the <option name="{fieldName}"/> element to the parent and returns the created element.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDOMExternalizerUtil

public JDOMExternalizerUtil()

Method Detail

writeField

public static void writeField(Element parent,
                              java.lang.String fieldName,
                              java.lang.String value)

Adds the <option name="{fieldName}" value="{value}"/> element to the parent.

writeField

public static void writeField(Element parent,
                              java.lang.String fieldName,
                              java.lang.String value,
                              java.lang.String defaultValue)

Adds the <option name="{fieldName}" value="{value}"/> element to the parent when the value differs from the default.

readField

public static java.lang.String readField(Element parent,
                                         java.lang.String fieldName,
                                         java.lang.String defaultValue)

readField

public static java.lang.String readField(Element parent,
                                         java.lang.String fieldName)

writeOption

public static Element writeOption(Element parent,
                                  java.lang.String fieldName)

Adds the <option name="{fieldName}"/> element to the parent and returns the created element.

readOption

public static Element readOption(Element parent,
                                 java.lang.String fieldName)

writeCustomField

public static void writeCustomField(Element parent,
                                    java.lang.String tagName,
                                    java.lang.String value)

Adds the <{tagName} value="{value}"/> element to the parent (or just <{tagName}"/> if the value is null).

readCustomField

public static java.lang.String readCustomField(Element parent,
                                               java.lang.String tagName)

getChildrenValueAttributes

public static java.util.List<java.lang.String> getChildrenValueAttributes(Element parent,
                                                                          java.lang.String childTagName)

addChildrenWithValueAttribute

public static void addChildrenWithValueAttribute(Element parent,
                                                 java.lang.String childTagName,
                                                 java.util.List<java.lang.String> attrValues)

addChildren

public static void addChildren(Element parent,
                               java.lang.String childElementName,
                               java.util.Collection<? extends JDOMExternalizable> children)
                        throws WriteExternalException

Throws:

WriteExternalException

addElementWithValueAttribute

@Deprecated
public static Element addElementWithValueAttribute(Element parent,
                                                   java.lang.String childTagName,
                                                   java.lang.String attrValue)

Deprecated. use writeCustomField(Element, String, String)

getFirstChildValueAttribute

@Deprecated
public static java.lang.String getFirstChildValueAttribute(Element parent,
                                                           java.lang.String childTagName)

Deprecated. use readCustomField(Element, String)