com.atlassian.jira.project.template.descriptor

Interface PluginParseHelper

All Known Implementing Classes:

DefaultPluginParseHelper

public interface PluginParseHelper

Field Summary

Fields

Modifier and Type	Field and Description
static PluginParseHelper	NULL_PARSE_HELPER Null PluginParseHelper that just returns null everywhere.

Method Summary

Modifier and Type	Method and Description
String	attribute(String name) Returns the value of a the attribute with the given name.
PluginParseHelper	element(String name) Returns a PluginParseHelper for the element with the given name.
String	optAttribute(String name) Returns the value of the attribute with the given name, or null.
Optional<PluginParseHelper>	optElement(String name) Returns a PluginParseHelper for the element with the given name if it exists, Option.none() if it doesn't.
org.dom4j.Element	rawElement() Returns the raw DOM4J element.
String	text() Returns the text within the current element.

Field Detail

NULL_PARSE_HELPER

static final PluginParseHelper NULL_PARSE_HELPER

Null PluginParseHelper that just returns null everywhere.

Method Detail

element

PluginParseHelper element(String name)

Returns a PluginParseHelper for the element with the given name.

Parameters:

name - an element name

Returns:

a PluginParseHelper

optElement

Optional<PluginParseHelper> optElement(String name)

Returns a PluginParseHelper for the element with the given name if it exists, Option.none() if it doesn't.

Parameters:

name - an element name

Returns:

an Option<PluginParseHelper>

attribute

String attribute(String name)
          throws com.atlassian.plugin.PluginParseException

Returns the value of a the attribute with the given name.

Parameters:

name - the attribute name

Returns:

the attribute value

Throws:

com.atlassian.plugin.PluginParseException - if the attribute is not defined

optAttribute

String optAttribute(String name)

Returns the value of the attribute with the given name, or null.

Parameters:

name - the attribute name

Returns:

the attribute value

text

String text()

Returns the text within the current element.

Returns:

the text

rawElement

org.dom4j.Element rawElement()

Returns the raw DOM4J element.

Returns:

the raw Element