org.jboss.hal.meta.description

Class ResourceDescription

java.lang.Object

org.jboss.hal.dmr.ModelNode

org.jboss.hal.meta.description.ResourceDescription

All Implemented Interfaces:

Cloneable

@JsType(namespace="hal.meta")
public class ResourceDescription
extends ModelNode

Contains the resource and attribute descriptions from the read-resource-description operation.

Property Summary

Properties inherited from class org.jboss.hal.dmr.ModelNode

asProperty

Constructor Summary

Constructors

Constructor and Description
ResourceDescription(ModelNode payload)

Method Summary

Modifier and Type	Method and Description
List<String>	findAlternatives(String path, String name) Returns the alternatives for the specified attribute.
Property	findAttribute(String path, String name)
List<String>	findRequires(String path, String name) Returns the attributes which require the specified attribute.
List<Property>	getAttributes(String path)
List<Property>	getAttributes(String path, String group)
String	getDescription()
List<Property>	getOperations()
List<Property>	getRequiredAttributes(String path)
boolean	isDefaultValue(String path, String name, Object value)
Property[]	jsGetAttributes()
Property[]	jsGetRequestProperties()
Property[]	jsOperations()

Methods inherited from class org.jboss.hal.dmr.ModelNode

add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addEmptyList, addEmptyObject, addExpression, as, asBigDecimal, asBigInteger, asBoolean, asBoolean, asBytes, asDouble, asDouble, asInt, asInt, asList, asLong, asLong, asObject, asProperty, asPropertyList, asString, asType, clear, clone, equals, equals, format, fromBase64, get, get, get, getFailureDescription, getType, has, has, hasDefined, hasDefined, hashCode, isDefined, isFailure, jsAsList, jsAsProperties, jsCreate, jsGetJSONString, keys, protect, remove, require, require, resolve, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setEmptyList, setEmptyObject, setExpression, setExpression, toBase64String, toJSONString, toJSONString, toString, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceDescription

@JsIgnore
public ResourceDescription(ModelNode payload)

Method Detail

getDescription

@JsProperty
public String getDescription()

Returns:

the resource description

getAttributes

@JsIgnore
public List<Property> getAttributes(String path)

getAttributes

@JsIgnore
public List<Property> getAttributes(String path,
                                              String group)

getRequiredAttributes

@JsIgnore
public List<Property> getRequiredAttributes(String path)

getOperations

@JsIgnore
public List<Property> getOperations()

findAttribute

@JsIgnore
public Property findAttribute(String path,
                                        String name)

findAlternatives

@JsIgnore
public List<String> findAlternatives(String path,
                                               String name)

Returns the alternatives for the specified attribute.

Parameters:

path - the path to look for the attribute

name - the name of the attribute

Returns:

the alternatives for name or an empty list if name has no alternatives or if there's no attribute name

findRequires

@JsIgnore
public List<String> findRequires(String path,
                                           String name)

Returns the attributes which require the specified attribute.

Parameters:

path - the path to look for the attribute

name - the name of the attribute which is required by the matching attributes

Returns:

the attributes which require or an empty list if no attributes require name or if there's no attribute name

isDefaultValue

@JsIgnore
public boolean isDefaultValue(String path,
                                        String name,
                                        Object value)

jsGetAttributes

@JsMethod(name="getAttributes")
public Property[] jsGetAttributes()

Returns:

the attribute descriptions

jsGetRequestProperties

@JsMethod(name="getRequestProperties")
public Property[] jsGetRequestProperties()

Returns:

the request properties of the add operation

jsOperations

@JsProperty(name="operations")
public Property[] jsOperations()

Returns:

the operation descriptions