org.jboss.hal.meta

Class Metadata

java.lang.Object

org.jboss.hal.meta.Metadata

@JsType
public class Metadata
extends Object

Simple data struct for common metadata. Used to keep the method signatures small and tidy.

Constructor Summary

Constructors

Constructor and Description
Metadata(AddressTemplate template, Supplier<SecurityContext> securityContext, ResourceDescription description, Capabilities capabilities)

Method Summary

Modifier and Type	Method and Description
void	copyAttribute(String attribute, Metadata destination) Copies attributes from this description to the specified metadata
void	copyComplexAttributeAttributes(Iterable<String> attributes, Metadata destination) Shortcut for copyAttribute(String, Metadata) and makeWritable(String)
static Metadata	empty()
Metadata	forComplexAttribute(String name) Creates a new metadata instance based on this metadata with the attributes taken from the specified complex attribute.
Metadata	forComplexAttribute(String name, boolean prefixLabel) Creates a new metadata instance based on this metadata with the attributes taken from the specified complex attribute.
Metadata	forOperation(String name)
Capabilities	getCapabilities()
ResourceDescription	getDescription()
SecurityContext	getSecurityContext()
AddressTemplate	getTemplate()
void	makeWritable(String attribute) Makes the specified attribute writable.
static Metadata	staticDescription(ResourceDescription description) Constructs a Metadata with read-write-execution permissions and a non-working Capabilities object.
static Metadata	staticDescription(ResourceDescription description, Environment environment) Constructs a Metadata with read-write-execution permissions and a working Capabilities object based on the environment object.
static Metadata	staticDescription(com.google.gwt.resources.client.TextResource description)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metadata

@JsIgnore
public Metadata(AddressTemplate template,
                          Supplier<SecurityContext> securityContext,
                          ResourceDescription description,
                          Capabilities capabilities)

Method Detail

empty

@JsIgnore
public static Metadata empty()

staticDescription

@JsIgnore
public static Metadata staticDescription(com.google.gwt.resources.client.TextResource description)

staticDescription

@JsIgnore
public static Metadata staticDescription(ResourceDescription description)

Constructs a Metadata with read-write-execution permissions and a non-working Capabilities object.

staticDescription

@JsIgnore
public static Metadata staticDescription(ResourceDescription description,
                                                   Environment environment)

Constructs a Metadata with read-write-execution permissions and a working Capabilities object based on the environment object.

copyAttribute

@JsIgnore
public void copyAttribute(String attribute,
                                    Metadata destination)

Copies attributes from this description to the specified metadata

makeWritable

@JsIgnore
public void makeWritable(String attribute)

Makes the specified attribute writable. This is necessary if you copy attributes from a complex attribute to another metadata. Without adjustment the copied attributes are read-only in the destination metadata.

copyComplexAttributeAttributes

@JsIgnore
public void copyComplexAttributeAttributes(Iterable<String> attributes,
                                                     Metadata destination)

Shortcut for copyAttribute(String, Metadata) and makeWritable(String)

forComplexAttribute

@JsIgnore
public Metadata forComplexAttribute(String name)

Creates a new metadata instance based on this metadata with the attributes taken from the specified complex attribute. The resource description will only include the attributes but no operations!

forComplexAttribute

@JsIgnore
public Metadata forComplexAttribute(String name,
                                              boolean prefixLabel)

Creates a new metadata instance based on this metadata with the attributes taken from the specified complex attribute. The resource description will only include the attributes but no operations!

Parameters:

prefixLabel - if true the labels of the attributes of the complex attribute are prefixed with name of the complex attribute.

forOperation

@JsIgnore
public Metadata forOperation(String name)

getTemplate

@JsProperty
public AddressTemplate getTemplate()

Returns:

the address template

getSecurityContext

@JsProperty
public SecurityContext getSecurityContext()

Returns:

the security context

getDescription

@JsProperty
public ResourceDescription getDescription()

Returns:

the resource description

getCapabilities

@JsIgnore
public Capabilities getCapabilities()