org.wildfly.swarm.config.runtime.model

Class AddressTemplate

java.lang.Object

org.wildfly.swarm.config.runtime.model.AddressTemplate

All Implemented Interfaces:

Comparable<AddressTemplate>

public class AddressTemplate
extends Object
implements Comparable<AddressTemplate>

Wrapper 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"
 

Here are some examples for address templates:

     AddressTemplate a1 = AddressTemplate.of("/");
     AddressTemplate a2 = AddressTemplate.of("{selected.profile}");
     AddressTemplate a3 = AddressTemplate.of("{selected.profile}/subsystem=mail");
     AddressTemplate a4 = AddressTemplate.of("{selected.profile}/subsystem=mail/mail-session=*");
 

To resolve a fully qualified address from an address template use the resolve(StatementContext, String...) method.

Author:

Harald Pehl

Method Summary

Modifier and Type	Method and Description
AddressTemplate	append(String template) Appends the specified template to this template and returns a new template.
int	compareTo(AddressTemplate o)
boolean	equals(Object o)
String	getResourceName()
String	getResourceType() Returns the resource type of the last segment for this address template
String	getTemplate()
int	hashCode()
boolean	isOptional()
static AddressTemplate	of(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.
AddressTemplate	subTemplate(int fromIndex, int toIndex) Works like List.subList(int, int) over the tokens of this template and throws the same exceptions.
Integer	tokenLength()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static AddressTemplate of(String template)

tokenLength

public Integer tokenLength()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

append

public AddressTemplate append(String template)

Appends the specified template to this template and returns a new template. If the specified template does not start with a slash, "/" is automatically appended.

Parameters:

template - the template to append (makes no difference whether it starts with "/" or not)

Returns:

a new template

subTemplate

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)

replaceWildcards

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.

getResourceType

public String getResourceType()

Returns the resource type of the last segment for this address template

Returns:

the resource type

getResourceName

public String getResourceName()

getTemplate

public String getTemplate()

isOptional

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

Returns:

a full qualified resource address which might be empty, but which does not contain any tokens

compareTo

public int compareTo(AddressTemplate o)

Specified by:

compareTo in interface Comparable<AddressTemplate>