Top Fields Methods
org.wildfly.client.config

public Interface ConfigurationXMLStreamReader

extends XMLStreamReader, AutoCloseable
Known Direct Implementers
org.wildfly.client.config.EmptyXMLStreamReader, org.wildfly.client.config.TextXMLStreamReader, org.wildfly.client.config.AbstractDelegatingXMLStreamReader, org.wildfly.client.config.BasicXMLStreamReader
Static Imports
org.wildfly.client.config._private.ConfigMessages.msg

Author
David M. Lloyd

Field Summary

Modifier and TypeField and Description
public static final char[]

Method Summary

Modifier and TypeMethod and Description
public default boolean

Returns:

true if the attribute has a namespace URI equal to the argument, or the argument is null or empty and the element has no namespace, or false otherwise
attributeNamespaceEquals
(int
the attribute index
idx
,
String
the namespace URI to test
uri
)

Determine whether the current element has an attribute at the given index with a namespace URI equal to the given value.

public void
close()

Redeclares javax.xml.stream.XMLStreamReader.close, java.lang.AutoCloseable.close.

Frees any resources associated with this Reader.
public static String
eventToString(final int type)

public String

Returns:

the attribute value
getAttributeValue
(int
the index of the attribute
index
)

Redeclares javax.xml.stream.XMLStreamReader.getAttributeValue.

Get the value of an attribute.
public default String

Returns:

the attribute value
getAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute with expressions resolved.

public default boolean

Returns:

the attribute value
getBooleanAttributeValue
(int
the attribute index
index
)

Get an attribute value as a boolean.

public default boolean

Returns:

the attribute value
getBooleanAttributeValueResolved
(int
the attribute index
index
)

Get an attribute value as a boolean with expressions resolved.

public default CidrAddress

Returns:

the attribute value
getCidrAddressAttributeValue
(int
the attribute index
index
)

Get an attribute value as a CidrAddress.

public default CidrAddress

Returns:

the attribute value
getCidrAddressAttributeValueResolved
(int
the attribute index
index
)

Get an attribute value as a CidrAddress with expressions resolved.

public default Expression

Returns:

the expression (not null)
getElementExpression
(Expression.Flag...
the expression compilation flags
flags
)

Get the element text content as an expression.

public default String
getElementText()

Implements javax.xml.stream.XMLStreamReader.getElementText.

Reads the content of a text-only element, an exception is thrown if this is not a text-only element.
public default Expression

Returns:

the expression, or null if the attribute is not present
getExpressionAttributeValue
(int
the attribute index
index
,
Expression.Flag...
the expression compilation flags
flags
)

Get an attribute value as a compiled Expression.

public XMLLocation
public default InetAddress

Returns:

the attribute value
getInetAddressAttributeValue
(int
the attribute index
index
)

Get an attribute value as a InetAddress.

public default InetAddress

Returns:

the attribute value
getInetAddressAttributeValueResolved
(int
the attribute index
index
)

Get an attribute value as a InetAddress with expressions resolved.

public default int

Returns:

the integer value
getIntAttributeValue
(int
the index of the attribute
index
)

Get the value of an attribute as an integer.

public default int

Returns:

the integer value
getIntAttributeValue
(int
the index of the attribute
index
,
int
the minimum allowed value
minValue
,
int
the maximum allowed value
maxValue
)

Get the value of an attribute as an integer.

public default int

Returns:

the integer value
getIntAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute as an integer with expressions resolved.

public default int

Returns:

the integer value
getIntAttributeValueResolved
(int
the index of the attribute
index
,
int
the minimum allowed value
minValue
,
int
the maximum allowed value
maxValue
)

Get the value of an attribute as an integer with expressions resolved.

public default int[]

Returns:

the integer values
getIntListAttributeValue
(int
the index of the attribute
index
)

Get the value of an attribute as an integer list.

public default int[]

Returns:

the integer values
getIntListAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute as an integer list with expressions resolved.

public default List<String>

Returns:

the values
getListAttributeValue
(int
the index of the attribute
index
)

Get the value of an attribute as a space-delimited string list.

public default String[]

Returns:

the values
getListAttributeValueAsArray
(int
the index of the attribute
index
)

Get the value of an attribute as a space-delimited string list, as an array.

public default String[]

Returns:

the values
getListAttributeValueAsArrayResolved
(int
the index of the attribute
index
)

Get the value of an attribute as a space-delimited string list with expressions resolved, as an array.

public default Iterator<String>

Returns:

the values
getListAttributeValueAsIterator
(int
the index of the attribute
index
)

Get the value of an attribute as a space-delimited string list, as an iterator.

public default Iterator<String>

Returns:

the values
getListAttributeValueAsIteratorResolved
(int
the index of the attribute
index
)

/** Get the value of an attribute as a space-delimited string list with expressions resolved, as an iterator.

public default List<String>

Returns:

the values
getListAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute as a space-delimited string list with expressions resolved.

public XMLLocation
getLocation()

Redeclares javax.xml.stream.XMLStreamReader.getLocation.

Return the current location of the processor.
public default long

Returns:

the long value
getLongAttributeValue
(int
the index of the attribute
index
)

Get the value of an attribute as a long.

public default long

Returns:

the long value
getLongAttributeValue
(int
the index of the attribute
index
,
long
the minimum allowed value
minValue
,
long
the maximum allowed value
maxValue
)

Get the value of an attribute as a long.

public default long

Returns:

the long value
getLongAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute as a long with expressions resolved.

public default long

Returns:

the long value
getLongAttributeValueResolved
(int
the index of the attribute
index
,
long
the minimum allowed value
minValue
,
long
the maximum allowed value
maxValue
)

Get the value of an attribute as a long with expressions resolved.

public default long[]

Returns:

the long values
getLongListAttributeValue
(int
the index of the attribute
index
)

Get the value of an attribute as a long integer list.

public default long[]

Returns:

the long values
getLongListAttributeValueResolved
(int
the index of the attribute
index
)

Get the value of an attribute as a long integer list with expressions resolved.

public default Object
getProperty(final String
The name of the property, may not be null
name
)

Implements javax.xml.stream.XMLStreamReader.getProperty.

Get the value of a feature/property from the underlying implementation
public int
getTextCharacters(int
the index of the first character in the source array to copy
sourceStart
,
char[]
the destination array
target
,
int
the start offset in the target array
targetStart
,
int
the number of characters to copy
length
)

Redeclares javax.xml.stream.XMLStreamReader.getTextCharacters.

Gets the text associated with a CHARACTERS, SPACE or CDATA event.
public URI
public default URI

Returns:

the attribute value
getURIAttributeValue
(int
the attribute index
index
)

Get an attribute value as a URI.

public default URI

Returns:

the attribute value
getURIAttributeValueResolved
(int
the attribute index
index
)

Get an attribute value as a URI with expressions resolved.

public XMLInputFactory
public default boolean

Returns:

true if the attribute has a non-empty namespace URI, false otherwise
hasAttributeNamespace
(int
the attribute index
idx
)

Determine whether the current element has an attribute at the given index with a non-empty namespace URI.

public default boolean
hasName()

Implements javax.xml.stream.XMLStreamReader.hasName.

returns a boolean indicating whether the current event has a name (is a START_ELEMENT or END_ELEMENT).
public default boolean

Returns:

true if the element has a non-empty namespace URI, false otherwise
hasNamespace
()

Determine whether the current element has a non-empty namespace URI.

public boolean
hasNext()

Redeclares javax.xml.stream.XMLStreamReader.hasNext.

Returns true if there are more parsing events and false if there are no more events.
public default boolean
hasText()

Implements javax.xml.stream.XMLStreamReader.hasText.

Return a boolean indicating whether the current event has text.
public default boolean
isCharacters()

Implements javax.xml.stream.XMLStreamReader.isCharacters.

Returns true if the cursor points to a character data event
public default boolean
isEndElement()

Implements javax.xml.stream.XMLStreamReader.isEndElement.

Returns true if the cursor points to an end tag (otherwise false)
public default boolean
isStandalone()

Implements javax.xml.stream.XMLStreamReader.isStandalone.

Get the standalone declaration from the xml declaration
public default boolean
isStartElement()

Implements javax.xml.stream.XMLStreamReader.isStartElement.

Returns true if the cursor points to a start tag (otherwise false)
public default boolean
isWhiteSpace()

Implements javax.xml.stream.XMLStreamReader.isWhiteSpace.

Returns true if the cursor points to a character data event that consists of all whitespace
public default ConfigXMLParseException

Returns:

the exception
missingRequiredAttribute
(String
the namespace URI (or null if it is a local name)
namespaceUri
,
String
the local attribute name
localName
)

Return a throwable exception explaining that a required attribute with the given namespace and local name was missing.

public default ConfigXMLParseException

Returns:

the exception
missingRequiredElement
(String
the namespace URI
namespaceUri
,
String
the local element name
localName
)

Return a throwable exception explaining that a required element with the given namespace and local name was missing.

public default boolean

Returns:

true if the element has a namespace URI equal to the argument, or the argument is null or empty and the element has no namespace, or false otherwise
namespaceURIEquals
(String
the namespace URI to test
uri
)

Determine whether the current element has a namespace URI equal to the given value.

public int
next()

Redeclares javax.xml.stream.XMLStreamReader.next.

Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks.
public default int
nextTag()

Implements javax.xml.stream.XMLStreamReader.nextTag.

Skips any white space (isWhiteSpace() returns true), COMMENT, or PROCESSING_INSTRUCTION, until a START_ELEMENT or END_ELEMENT is reached.
public default ConfigXMLParseException

Returns:

the exception
numericAttributeValueOutOfRange
(int
the attribute index
index
,
long
the minimum attribute value
minValue
,
long
the maximum attribute value
maxValue
)

Return a throwable exception explaining that a numeric attribute at the given index was out of its required range.

public default void
require(final int
the event type
type
,
final String
the uri of the event, may be null
namespaceURI
,
final String
the localName of the event, may be null
localName
)

Implements javax.xml.stream.XMLStreamReader.require.

Test if the current event is of the given type and if the namespace and name match the current namespace and name of the current event.
public default void
public default boolean
standaloneSet()

Implements javax.xml.stream.XMLStreamReader.standaloneSet.

Checks if standalone was set in the document
public default ConfigXMLParseException

Returns:

the exception
unexpectedAttribute
(int
the attribute index
i
)

Return a throwable exception explaining that the attribute at the current position with the given index was not expected.

public default ConfigXMLParseException

Returns:

the exception
unexpectedContent
()

Return a throwable exception explaining that some unexpected content was encountered.

public default ConfigXMLParseException

Returns:

the exception
unexpectedDocumentEnd
()

Return a throwable exception explaining that the document end was reached unexpectedly.

public default ConfigXMLParseException

Returns:

the exception
unexpectedElement
()

Return a throwable exception explaining that the element at the current position was not expected.

Inherited from javax.xml.stream.XMLStreamReader:
getAttributeCountgetAttributeLocalNamegetAttributeNamegetAttributeNamespacegetAttributePrefixgetAttributeTypegetAttributeValuegetCharacterEncodingSchemegetEncodinggetEventTypegetLocalNamegetNamegetNamespaceContextgetNamespaceCountgetNamespacePrefixgetNamespaceURIgetNamespaceURIgetNamespaceURIgetPIDatagetPITargetgetPrefixgetTextgetTextCharactersgetTextLengthgetTextStartgetVersionisAttributeSpecified