AddressTemplate (HAL :: Console 3.0.0.Alpha3 API)

java.lang.Object
- org.jboss.hal.meta.AddressTemplate

All Implemented Interfaces:

Iterable<String>
```
@JsType(namespace="hal.meta")
public final class AddressTemplate
extends Object
implements Iterable<String>
```
Template for a DMR address which might contain multiple variable parts. An address template can be defined using the following BNF:
```
 <address template> ::= "/" | <segment>
 <segment>          ::= <tuple> | <segment>"/"<tuple>
 <tuple>            ::= <variable> | <key>"="<value>
 <variable>         ::= "{"<alpha>"}"
 <key>              ::= <alpha>
 <value>            ::= <variable> | <alpha> | "*"
 <alpha>            ::= <upper> | <lower>
 <upper>            ::= "A" | "B" | … | "Z"
 <lower>            ::= "a" | "b" | … | "z"
 
```
Following variables are supported: - {domain.controller} - {selected.profile} - {selected.group} - {selected.server-config} - {selected.server} To get a fully qualified address from an address template use the method resolve(). For standalone mode the variables will resolve to an empty string. The values of the variables are managed by the StatementContext.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AddressTemplate.Unresolver

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AddressTemplate.Unresolver`

Field Summary

Fields
Modifier and Type Field and Description

static String EQUALS

static String OPTIONAL

static AddressTemplate ROOT
The root template

Fields
Modifier and Type	Field and Description
`static String`	`EQUALS`
`static String`	`OPTIONAL`
`static AddressTemplate`	`ROOT` The root template

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressTemplate`	`append(AddressTemplate template)`
`AddressTemplate`	`append(String template)` Appends the specified encoded template to this template and returns a new template.
`boolean`	`equals(Object o)`
`String`	`firstName()`
`String`	`firstValue()`
`AddressTemplate`	`getParent()`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isOptional()`
`@NotNull Iterator<String>`	`iterator()`
`AddressTemplate`	`jsAppend(Object address)` Append an address to this addrress template and return a new one.
`String`	`lastName()`
`String`	`lastValue()`
`static AddressTemplate`	`of(ResourceAddress address)` Turns a resource address into an address template which is the opposite of `resolve(StatementContext, String...)`.
`static AddressTemplate`	`of(ResourceAddress address, AddressTemplate.Unresolver unresolver)` Turns a resource address into an address template which is the opposite of `resolve(StatementContext, String...)`.
`static AddressTemplate`	`of(StatementContext.Tuple placeholder)` Creates a new address template from a well known placeholder.
`static AddressTemplate`	`of(StatementContext.Tuple placeholder1, StatementContext.Tuple placeholder2)` Creates a new address template from two placeholders.
`static AddressTemplate`	`of(StatementContext.Tuple placeholder1, StatementContext.Tuple placeholder2, String template)` Creates a new address template from two placeholders and an encoded string template.
`static AddressTemplate`	`of(StatementContext.Tuple placeholder, String template)` Creates a new address template from a placeholder and an encoded string template.
`static AddressTemplate`	`of(String template)` Creates a new address template from an encoded string template.
`AddressTemplate`	`replaceWildcards(String wildcard, String... wildcards)` Replaces one or more wildcards with the specified values starting from left to right and returns a new address template.
`ResourceAddress`	`resolve(StatementContext context, String... wildcards)` Resolve this address template against the specified statement context.
`int`	`size()`
`AddressTemplate`	`subTemplate(int fromIndex, int toIndex)` Works like `List.subList(int, int)` over the tokens of this template and throws the same exceptions.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - ROOT
```
public static final AddressTemplate ROOT
```
    The root template
  - EQUALS
```
public static final String EQUALS
```
    See Also:
    
    Constant Field Values
  - OPTIONAL
```
@JsIgnore
public static final String OPTIONAL
```
    See Also:
    
    Constant Field Values
- Method Detail
  - of
```
@JsIgnore
public static AddressTemplate of(StatementContext.Tuple placeholder)
```
    Creates a new address template from a well known placeholder.
  - of
```
@JsIgnore
public static AddressTemplate of(StatementContext.Tuple placeholder,
                                           @NonNls
                                           String template)
```
    Creates a new address template from a placeholder and an encoded string template. '/' characters inside values must have been encoded using ModelNodeHelper.encodeValue(String).
  - of
```
@JsIgnore
public static AddressTemplate of(StatementContext.Tuple placeholder1,
                                           StatementContext.Tuple placeholder2)
```
    Creates a new address template from two placeholders.
  - of
```
@JsIgnore
public static AddressTemplate of(StatementContext.Tuple placeholder1,
                                           StatementContext.Tuple placeholder2,
                                           @NonNls
                                           String template)
```
    Creates a new address template from two placeholders and an encoded string template. '/' characters inside values must have been encoded using ModelNodeHelper.encodeValue(String).
  - of
```
public static AddressTemplate of(@NonNls
                                 String template)
```
    Creates a new address template from an encoded string template.
  - of
```
@JsIgnore
public static AddressTemplate of(ResourceAddress address)
```
    Turns a resource address into an address template which is the opposite of resolve(StatementContext, String...).
  - of
```
@JsIgnore
public static AddressTemplate of(ResourceAddress address,
                                           AddressTemplate.Unresolver unresolver)
```
    Turns a resource address into an address template which is the opposite of resolve(StatementContext, String...). Use the AddressTemplate.Unresolver function to specify how the segments of the resource address are "unresolved". It is called for each segment of the specified resource address.
  - equals
```
@JsIgnore
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
@JsIgnore
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this address template
  - isEmpty
```
@JsProperty
public boolean isEmpty()
```
    Returns:
    
    true if this template contains no tokens, false otherwise
  - size
```
@JsProperty(name="size")
public int size()
```
    Returns:
    
    the number of tokens
  - iterator
```
@NotNull
 @JsIgnore
public @NotNull Iterator<String> iterator()
```
    Specified by:
    
    iterator in interface Iterable<String>
  - append
```
@JsIgnore
public AddressTemplate append(@NonNls
                                        String template)
```
    Appends the specified encoded template to this template and returns a new template. If the specified template does not start with a slash, '/' is automatically appended. '/' characters inside values must have been encoded using ModelNodeHelper.encodeValue(String).
    
    Parameters:
    
    template - the encoded template to append (makes no difference whether it starts with '/' or not)
    
    Returns:
    
    a new template
  - append
```
@JsIgnore
public AddressTemplate append(AddressTemplate template)
```
  - subTemplate
```
@JsIgnore
public AddressTemplate subTemplate(int fromIndex,
                                             int toIndex)
```
    Works like List.subList(int, int) over the tokens of this template and throws the same exceptions.
    
    Parameters:
    
    fromIndex - low endpoint (inclusive) of the sub template
    
    toIndex - high endpoint (exclusive) of the sub template
    
    Returns:
    
    a new address template containing the specified tokens.
    
    Throws:
    
    IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex)
  - getParent
```
@JsProperty
public AddressTemplate getParent()
```
    Returns:
    
    the parent address template or the root template
  - replaceWildcards
```
@JsIgnore
public AddressTemplate replaceWildcards(String wildcard,
                                                  String... wildcards)
```
    Replaces one or more wildcards with the specified values starting from left to right and returns a new address template.
    This method does not resolve the address template. The returned template is still unresolved.
    
    Parameters:
    
    wildcard - the first wildcard (mandatory)
    
    wildcards - more wildcards (optional)
    
    Returns:
    
    a new (still unresolved) address template with the wildcards replaced by the specified values.
  - firstName
```
@JsProperty(name="firstName")
public String firstName()
```
    Returns:
    
    the name of the first segment or null if this address template is empty.
  - firstValue
```
@JsProperty(name="firstValue")
public String firstValue()
```
    Returns:
    
    the value of the first segment or null if this address template is empty.
  - lastName
```
@JsProperty(name="lastName")
public String lastName()
```
    Returns:
    
    the name of the last segment or null if this address template is empty.
  - lastValue
```
@JsProperty(name="lastValue")
public String lastValue()
```
    Returns:
    
    the value of the last segment or null if this address template is empty.
  - isOptional
```
@JsIgnore
public boolean isOptional()
```
  - resolve
```
public ResourceAddress resolve(StatementContext context,
                               String... wildcards)
```
    Resolve this address template against the specified statement context.
    
    Parameters:
    
    context - the statement context
    
    wildcards - An optional list of wildcards which are used to resolve any wildcards in this address template from left to right
    
    Returns:
    
    a fully qualified resource address which might be empty, but which does not contain any tokens
  - jsAppend
```
@JsMethod(name="append")
public AddressTemplate jsAppend(Object address)
```
    Append an address to this addrress template and return a new one.
    
    Parameters:
    
    address - The address to append.
    
    Returns:
    
    a new address template with the specified address added at the end.

Class AddressTemplate

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

ROOT

EQUALS

OPTIONAL

Method Detail

of

of

of

of

of

of

of

equals

hashCode

toString

isEmpty

size

iterator

append

append

subTemplate

getParent

replaceWildcards

firstName

firstValue

lastName

lastValue

isOptional

resolve

jsAppend