org.hawkular.dmrclient

Class Address

java.lang.Object

org.hawkular.dmrclient.Address

All Implemented Interfaces:

Cloneable

public class Address
extends Object
implements Cloneable

Identifies a managed resource in the DMR hierarchy.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
Address() Creates a root() address.
Address(String... addressParts) Creates an address with the given parts.

Method Summary

Modifier and Type	Method and Description
Address	add(Address address) Appends the given address to this address.
Address	add(String... addressParts) Appends the given address parts to this address.
Address	add(String type, String name) Adds a single level to this address.
Address	clone()
boolean	equals(Object obj)
static Address	fromModelNode(org.jboss.dmr.ModelNode node) Obtains the address from the given ModelNode which is assumed to be a property list that contains all the address parts and only the address parts.
static Address	fromModelNodeWrapper(org.jboss.dmr.ModelNode haystack, String needle) Obtains an address property list from the given ModelNode wrapper.
org.jboss.dmr.ModelNode	getAddressNode() Returns this address as a ModelNode.
int	hashCode()
boolean	isRoot()
static Address	parse(String addressStr) Parses a flat address string that has the syntax "/type1=name/type2=name/.../typeN=nameN".
static Address	root() Returns the root address which is denoted as the flat address string of "/".
String[]	toAddressParts()
String	toAddressPathString() Returns the address as a flattened string that is compatible with the DMR CLI address paths.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Address

public Address()

Creates a root() address.

Address

public Address(String... addressParts)

Creates an address with the given parts. See add(String...).

Parameters:

addressParts - the type/name parts of an address.

Method Detail

root

public static Address root()

Returns the root address which is denoted as the flat address string of "/".

Returns:

root address

parse

public static Address parse(String addressStr)

Parses a flat address string that has the syntax "/type1=name/type2=name/.../typeN=nameN".

Parameters:

addressStr - flat address string

Returns:

address

fromModelNode

public static Address fromModelNode(org.jboss.dmr.ModelNode node)

Obtains the address from the given ModelNode which is assumed to be a property list that contains all the address parts and only the address parts.

Parameters:

node - address node

Returns:

the address

fromModelNodeWrapper

public static Address fromModelNodeWrapper(org.jboss.dmr.ModelNode haystack,
                                           String needle)

Obtains an address property list from the given ModelNode wrapper. The given haystack must have a key whose value is the same as needle. The value of that named property must itself be a property list containing all address parts (and only address parts).

Parameters:

haystack - the wrapper ModelNode that contains a property whose value is an address property list.

needle - the name of the property in the given wrapper ModelNode whose value is the address property list.

Returns:

the found address

Throws:

IllegalArgumentException - there is no address property list in the wrapper node with the given name.

See Also:

fromModelNode(ModelNode)

getAddressNode

public org.jboss.dmr.ModelNode getAddressNode()

Returns this address as a ModelNode.

Returns:

the address ModelNode representation

add

public Address add(String... addressParts)

Appends the given address parts to this address. This lets you build up addresses in a step-wise fashion.

Parameters:

addressParts - new address parts to add to the address.

Returns:

this address (which now has the new address parts appended).

add

public Address add(String type,
                   String name)

Adds a single level to this address. For example, if this address is currently "/a=b" and this method is called with type=x and name=y this address will now be "/a=b/x=y".

Parameters:

type - the new address part's type

name - the new address part's name

Returns:

this address with the new address part added to it

add

public Address add(Address address)

Appends the given address to this address. This lets you build up addresses in a step-wise fashion.

Parameters:

address - new address to appen to this address.

Returns:

this address (which now has the new address appended).

isRoot

public boolean isRoot()

Returns:

true if this address represents the root address ("/").

toAddressParts

public String[] toAddressParts()

Returns:

returns the address split into its individual parts. e.g. "/one=two" will return a 2-element array {"one", "two"}.

toAddressPathString

public String toAddressPathString()

Returns the address as a flattened string that is compatible with the DMR CLI address paths. For example, an Address whose ModelNode representation is: [ ("one" => "two"), ("three" => "four") ] will have a flat string of /one=two/three=four

Returns:

flattened address path string

clone

public Address clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object