Package org.infinispan.configuration.parsing

Class ParseUtils

java.lang.Object

org.infinispan.configuration.parsing.ParseUtils

public final class ParseUtils
extends Object

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
static org.infinispan.commons.CacheConfigurationException	attributeRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader, int attributeIndex)
static org.infinispan.commons.CacheConfigurationException	attributeRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader, int attributeIndex, String newAttributeName)
static org.infinispan.commons.configuration.io.ConfigurationReaderException	duplicateAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, String name)	Get an exception reporting that an attribute of a given name has already been declared in this scope.
static org.infinispan.commons.configuration.io.ConfigurationReaderException	duplicateNamedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, String name)	Get an exception reporting that an element of a given type and name has already been declared in this scope.
static org.infinispan.commons.CacheConfigurationException	elementRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader)
static org.infinispan.commons.CacheConfigurationException	elementRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader, String newElementName)
static Namespace[]	getNamespaceAnnotations(Class<?> cls)
static void	ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, int attributeIndex)
static void	ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, Enum<?> attribute)
static void	ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, String attributeName)
static void	ignoreElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, Enum<?> element)
static void	introducedFrom(org.infinispan.commons.configuration.io.ConfigurationReader reader, int major, int minor)
static org.infinispan.commons.configuration.io.ConfigurationReaderException	invalidAttributeValue(org.infinispan.commons.configuration.io.ConfigurationReader reader, int index)	Get an exception reporting an invalid XML attribute value.
static boolean	isNoNamespaceAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, int index)
static org.infinispan.commons.configuration.io.ConfigurationReaderException	missingRequired(org.infinispan.commons.configuration.io.ConfigurationReader reader, Set<?> required)	Get an exception reporting a missing, required XML attribute.
static org.infinispan.commons.configuration.io.ConfigurationReaderException	missingRequiredElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, Set<?> required)	Get an exception reporting a missing, required XML child element.
static Element	nextElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)
static void	parseAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader, org.infinispan.commons.configuration.Builder<?> builder)
static boolean	parseBoolean(org.infinispan.commons.configuration.io.ConfigurationReader reader, int i, String value)
static <T extends Enum<T>> T	parseEnum(org.infinispan.commons.configuration.io.ConfigurationReader reader, int i, Class<T> enumClass, String value)
static Integer	parseInt(org.infinispan.commons.configuration.io.ConfigurationReader reader, int i, String value)
static long	parseLong(org.infinispan.commons.configuration.io.ConfigurationReader reader, int i, String value)
static boolean	readBooleanAttributeElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, String attributeName)	Read an element which contains only a single boolean attribute.
static String	readStringAttributeElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, String attributeName)	Read an element which contains only a single string attribute.
static void	removedSince(org.infinispan.commons.configuration.io.ConfigurationReader reader, int major, int minor)
static String	requireAttributeProperty(org.infinispan.commons.configuration.io.ConfigurationReader reader, int i)
static String[]	requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader, boolean replace, String... attributeNames)	Require all the named attributes, returning their values in order.
static String[]	requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader, Enum<?>... attributes)
static String[]	requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader, String... attributeNames)
static void	requireNoAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader)	Checks that the current element has no attributes, throwing an ConfigurationReaderException if one is found.
static void	requireNoContent(org.infinispan.commons.configuration.io.ConfigurationReader reader)	Consumes the remainder of the current element, throwing an ConfigurationReaderException if it contains any child elements.
static void	requireNoNamespaceAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, int index)
static String	requireSingleAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, Enum<?> attribute)
static String	requireSingleAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, String attributeName)	Require that the current element have only a single attribute with the given name.
static String	resolvePath(String path, String relativeTo)
static org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, int index)	Get an exception reporting an unexpected XML attribute.
static org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader, String name)	Get an exception reporting an unexpected XML attribute.
static org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)	Get an exception reporting an unexpected XML element.
static org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, String element)
static <T extends Enum<T>> org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader, T element)
static org.infinispan.commons.configuration.io.ConfigurationReaderException	unexpectedEndElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)	Get an exception reporting an unexpected end tag for an XML element.

Methods inherited from class java.lang.Object

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

Method Details

nextElement

public static Element nextElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)
                           throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

unexpectedElement

public static org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)

Get an exception reporting an unexpected XML element.

Parameters:

reader - the stream reader

Returns:

the exception

unexpectedElement

public static <T extends Enum<T>>
org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 T element)

unexpectedElement

public static org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String element)

unexpectedEndElement

public static org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedEndElement(org.infinispan.commons.configuration.io.ConfigurationReader reader)

Get an exception reporting an unexpected end tag for an XML element.

Parameters:

reader - the stream reader

Returns:

the exception

unexpectedAttribute

public static org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int index)

Get an exception reporting an unexpected XML attribute.

Parameters:

reader - the stream reader

index - the attribute index

Returns:

the exception

unexpectedAttribute

public static org.infinispan.commons.configuration.io.ConfigurationReaderException unexpectedAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String name)

Get an exception reporting an unexpected XML attribute.

Parameters:

reader - the stream reader

name - the attribute name

Returns:

the exception

invalidAttributeValue

public static org.infinispan.commons.configuration.io.ConfigurationReaderException invalidAttributeValue(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int index)

Get an exception reporting an invalid XML attribute value.

Parameters:

reader - the stream reader

index - the attribute index

Returns:

the exception

missingRequired

public static org.infinispan.commons.configuration.io.ConfigurationReaderException missingRequired(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Set<?> required)

Get an exception reporting a missing, required XML attribute.

Parameters:

reader - the stream reader

required - a set of enums whose toString method returns the attribute name

Returns:

the exception

missingRequiredElement

public static org.infinispan.commons.configuration.io.ConfigurationReaderException missingRequiredElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Set<?> required)

Get an exception reporting a missing, required XML child element.

Parameters:

reader - the stream reader

required - a set of enums whose toString method returns the attribute name

Returns:

the exception

requireNoAttributes

public static void requireNoAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader)
                                throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Checks that the current element has no attributes, throwing an ConfigurationReaderException if one is found.

Parameters:

reader - the reader

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs

requireNoContent

public static void requireNoContent(org.infinispan.commons.configuration.io.ConfigurationReader reader)
                             throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Consumes the remainder of the current element, throwing an ConfigurationReaderException if it contains any child elements.

Parameters:

reader - the reader

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs

duplicateAttribute

public static org.infinispan.commons.configuration.io.ConfigurationReaderException duplicateAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String name)

Get an exception reporting that an attribute of a given name has already been declared in this scope.

Parameters:

reader - the stream reader

name - the name that was redeclared

Returns:

the exception

duplicateNamedElement

public static org.infinispan.commons.configuration.io.ConfigurationReaderException duplicateNamedElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String name)

Get an exception reporting that an element of a given type and name has already been declared in this scope.

Parameters:

reader - the stream reader

name - the name that was redeclared

Returns:

the exception

readBooleanAttributeElement

public static boolean readBooleanAttributeElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String attributeName)
                                           throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Read an element which contains only a single boolean attribute.

Parameters:

reader - the reader

attributeName - the attribute name, usually "value"

Returns:

the boolean value

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs or if the element does not contain the specified attribute, contains other attributes, or contains child elements.

readStringAttributeElement

public static String readStringAttributeElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String attributeName)
                                         throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Read an element which contains only a single string attribute.

Parameters:

reader - the reader

attributeName - the attribute name, usually "value" or "name"

Returns:

the string value

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs or if the element does not contain the specified attribute, contains other attributes, or contains child elements.

requireSingleAttribute

public static String requireSingleAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String attributeName)
                                     throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Require that the current element have only a single attribute with the given name.

Parameters:

reader - the reader

attributeName - the attribute name

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs

requireSingleAttribute

public static String requireSingleAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Enum<?> attribute)
                                     throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

requireAttributes

public static String[] requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 boolean replace,
 String... attributeNames)
                                  throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Require all the named attributes, returning their values in order.

Parameters:

reader - the reader

attributeNames - the attribute names

Returns:

the attribute values in order

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException - if an error occurs

requireAttributes

public static String[] requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String... attributeNames)
                                  throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

requireAttributes

public static String[] requireAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Enum<?>... attributes)
                                  throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

isNoNamespaceAttribute

public static boolean isNoNamespaceAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int index)

requireNoNamespaceAttribute

public static void requireNoNamespaceAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int index)
                                        throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

getNamespaceAnnotations

public static Namespace[] getNamespaceAnnotations(Class<?> cls)

resolvePath

public static String resolvePath(String path,
 String relativeTo)

requireAttributeProperty

public static String requireAttributeProperty(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int i)
                                       throws org.infinispan.commons.configuration.io.ConfigurationReaderException

Throws:

org.infinispan.commons.configuration.io.ConfigurationReaderException

ignoreAttribute

public static void ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String attributeName)

ignoreAttribute

public static void ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int attributeIndex)

ignoreAttribute

public static void ignoreAttribute(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Enum<?> attribute)

ignoreElement

public static void ignoreElement(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 Enum<?> element)

elementRemoved

public static org.infinispan.commons.CacheConfigurationException elementRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 String newElementName)

elementRemoved

public static org.infinispan.commons.CacheConfigurationException elementRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader)

attributeRemoved

public static org.infinispan.commons.CacheConfigurationException attributeRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int attributeIndex,
 String newAttributeName)

attributeRemoved

public static org.infinispan.commons.CacheConfigurationException attributeRemoved(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int attributeIndex)

parseAttributes

public static void parseAttributes(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 org.infinispan.commons.configuration.Builder<?> builder)

parseInt

public static Integer parseInt(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int i,
 String value)

parseLong

public static long parseLong(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int i,
 String value)

parseEnum

public static <T extends Enum<T>> T parseEnum(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int i,
 Class<T> enumClass,
 String value)

parseBoolean

public static boolean parseBoolean(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int i,
 String value)

introducedFrom

public static void introducedFrom(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int major,
 int minor)

removedSince

public static void removedSince(org.infinispan.commons.configuration.io.ConfigurationReader reader,
 int major,
 int minor)