Package io.helidon.config

Interface Config.Key

All Superinterfaces:

java.lang.Comparable<Config.Key>

Enclosing interface:

Config

public static interface Config.Key
extends java.lang.Comparable<Config.Key>

Object represents fully-qualified key of config node.

Fully-qualified key is list of key tokens separated by . (dot character). Depending on context the key token is evaluated one by one:

• in Config.Type.OBJECT node the token represents a name of object member;
• in Config.Type.LIST node the token represents an zero-based index of list element, an unsigned base-10 integer value, leading zeros are not allowed.

The ABNF syntax of config key is:

 config-key = *1( key-token *( "." key-token ) )
  key-token = *( unescaped / escaped )
  unescaped = %x00-2D / %x2F-7D / %x7F-10FFFF
            ; %x2E ('.') and %x7E ('~') are excluded from 'unescaped'
    escaped = "~" ( "0" / "1" )
            ; representing '~' and '.', respectively
 

See Also:

Config.key()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	escapeName(java.lang.String name)	Escape '~' to ~0 and '.' to ~1 in specified name.
default boolean	isRoot()	Returns true in case the key represents root config node, otherwise it returns false.
java.lang.String	name()	Returns the name of Config node.
static Config.Key	of(java.lang.String key)	Creates new instance of Key for specified key literal.
Config.Key	parent()	Returns instance of Key that represents key of parent config node.
java.lang.String	toString()	Returns formatted fully-qualified key.
static java.lang.String	unescapeName(java.lang.String escapedName)	Unescape ~0 to '~' and ~1 to '.' in specified escaped name.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

parent

Config.Key parent()

Returns instance of Key that represents key of parent config node.

If the key represents root config node it returns null.

Returns:

key that represents key of parent config node.

See Also:

isRoot()

isRoot

default boolean isRoot()

Returns true in case the key represents root config node, otherwise it returns false.

Returns:

true in case the key represents root node, otherwise false.

See Also:

parent()

name

java.lang.String name()

Returns the name of Config node.

The name of a node is the last token in fully-qualified key. Depending on context the name is evaluated one by one:

• in Config.Type.OBJECT node the name represents a name of object member;
• in Config.Type.LIST node the name represents an zero-based index of list element, an unsigned base-10 integer value, leading zeros are not allowed.

Returns:

name of config node

See Also:

Config.name()

toString

java.lang.String toString()

Returns formatted fully-qualified key.

Overrides:

toString in class java.lang.Object

Returns:

formatted fully-qualified key.

of

static Config.Key of(java.lang.String key)

Creates new instance of Key for specified key literal.

Empty literal means root node. Character dot ('.') has special meaning - it separates fully-qualified key by key tokens (node names).

Parameters:

key - formatted fully-qualified key.

Returns:

Key instance representing specified fully-qualified key.

escapeName

static java.lang.String escapeName(java.lang.String name)

Escape '~' to ~0 and '.' to ~1 in specified name.

Parameters:

name - name to be escaped

Returns:

escaped name

unescapeName

static java.lang.String unescapeName(java.lang.String escapedName)

Unescape ~0 to '~' and ~1 to '.' in specified escaped name.

Parameters:

escapedName - escaped name

Returns:

unescaped name