Package org.infinispan.commons.configuration.io

Interface ConfigurationReader

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractConfigurationReader, JsonConfigurationReader, XmlConfigurationReader, YamlConfigurationReader

public interface ConfigurationReader
extends AutoCloseable

Since:

12.1

Author:

Tristan Tarrant <tristan@infinispan.org>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConfigurationReader.Builder
static enum	ConfigurationReader.ElementType

Method Summary

Modifier and Type	Method	Description
void	close()
void	endMapItem()
static ConfigurationReader.Builder	from(InputStream is)
static ConfigurationReader.Builder	from(Reader reader)
static ConfigurationReader.Builder	from(String s)
int	getAttributeCount()
String	getAttributeName(int index)
String	getAttributeName(int index, NamingStrategy strategy)
String	getAttributeNamespace(int index)
String	getAttributeValue(int index)
default String	getAttributeValue(Enum<?> localName)
default String	getAttributeValue(Enum<?> localName, NamingStrategy strategy)
String	getAttributeValue(String localName)
String	getAttributeValue(String localName, NamingStrategy strategy)
String	getElementText()
default String[]	getListAttributeValue(int index)	Get the value of an attribute as a space-delimited string list.
String	getLocalName()
String	getLocalName(NamingStrategy strategy)
Location	getLocation()
Map.Entry<String,String>	getMapItem(Enum<?> nameAttribute)
Map.Entry<String,String>	getMapItem(String nameAttribute)
String	getName()
String	getNamespace()
NamingStrategy	getNamingStrategy()
Properties	getProperties()
<T> T	getProperty(String name)
ConfigurationResourceResolver	getResourceResolver()
ConfigurationSchemaVersion	getSchema()
void	handleAny(ConfigurationReaderContext context)
void	handleAttribute(ConfigurationReaderContext context, int i)
boolean	hasFeature(ConfigurationFormatFeature feature)
boolean	hasNext()
default boolean	inTag()
default boolean	inTag(Enum<?> name)
default boolean	inTag(String name)
ConfigurationReader.ElementType	nextElement()
String[]	readArray(Enum<?> outer, Enum<?> inner)
String[]	readArray(String outer, String inner)
default void	require(ConfigurationReader.ElementType type)
default void	require(ConfigurationReader.ElementType type, String namespace, Enum<?> name)
void	require(ConfigurationReader.ElementType type, String namespace, String name)
default void	setAttributeValue(String namespace, Enum<?> localName, String value)
void	setAttributeValue(String namespace, String name, String value)
void	setSchema(ConfigurationSchemaVersion schema)

Method Details

from

static ConfigurationReader.Builder from(InputStream is)

from

static ConfigurationReader.Builder from(Reader reader)

from

static ConfigurationReader.Builder from(String s)

getName

String getName()

getResourceResolver

ConfigurationResourceResolver getResourceResolver()

Returns:

the resource resolver used by this ConfigurationReader to find external references (e.g. includes)

getNamingStrategy

NamingStrategy getNamingStrategy()

Returns:

the naming strategy used by this ConfigurationReader

setSchema

void setSchema(ConfigurationSchemaVersion schema)

Parameters:

schema - the ConfigurationSchema in use

getSchema

ConfigurationSchemaVersion getSchema()

Returns:

the schema

nextElement

ConfigurationReader.ElementType nextElement()

Returns:

the next element

inTag

default boolean inTag()

inTag

default boolean inTag(String name)

inTag

default boolean inTag(Enum<?> name)

getLocation

Location getLocation()

getProperty

<T> T getProperty(String name)

getProperties

Properties getProperties()

getAttributeName

String getAttributeName(int index)

getAttributeName

String getAttributeName(int index,
 NamingStrategy strategy)

getAttributeNamespace

String getAttributeNamespace(int index)

getAttributeValue

String getAttributeValue(String localName)

getAttributeValue

default String getAttributeValue(Enum<?> localName)

getAttributeValue

String getAttributeValue(String localName,
 NamingStrategy strategy)

getAttributeValue

default String getAttributeValue(Enum<?> localName,
 NamingStrategy strategy)

getAttributeValue

String getAttributeValue(int index)

getListAttributeValue

default String[] getListAttributeValue(int index)

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

Parameters:

index - the index of the attribute

getElementText

String getElementText()

getLocalName

String getLocalName()

getLocalName

String getLocalName(NamingStrategy strategy)

getNamespace

String getNamespace()

hasNext

boolean hasNext()

getAttributeCount

int getAttributeCount()

handleAny

void handleAny(ConfigurationReaderContext context)

handleAttribute

void handleAttribute(ConfigurationReaderContext context,
 int i)

require

default void require(ConfigurationReader.ElementType type)

require

void require(ConfigurationReader.ElementType type,
 String namespace,
 String name)

require

default void require(ConfigurationReader.ElementType type,
 String namespace,
 Enum<?> name)

getMapItem

Map.Entry<String,String> getMapItem(String nameAttribute)

getMapItem

Map.Entry<String,String> getMapItem(Enum<?> nameAttribute)

endMapItem

void endMapItem()

readArray

String[] readArray(Enum<?> outer,
 Enum<?> inner)

readArray

String[] readArray(String outer,
 String inner)

hasFeature

boolean hasFeature(ConfigurationFormatFeature feature)

close

void close()

Specified by:

close in interface AutoCloseable

setAttributeValue

void setAttributeValue(String namespace,
 String name,
 String value)

setAttributeValue

default void setAttributeValue(String namespace,
 Enum<?> localName,
 String value)