RendererHints (Apache Brooklyn)

java.lang.Object
- brooklyn.config.render.RendererHints

```
public class RendererHints
extends java.lang.Object
```
Registry of hints for displaying items such as sensors, e.g. in the web console.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RendererHints.DisplayValue<T>` This hint describes a transformation used to generate a display value for config keys and sensors.
`static class`	`RendererHints.Hint<T>` Parent marker class for hints.
`static interface`	`RendererHints.NamedAction`
`static class`	`RendererHints.NamedActionWithUrl<T>` This hint describes a named action possible on something, e.g.

Constructor Summary

Constructors
Constructor and Description

RendererHints()

Constructors
Constructor and Description
`RendererHints()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.Object`	`applyDisplayValueHint(AttributeSensor<?> target, java.lang.Object initialValue)` Applies the (first) display value hint registered against the given target to the given initialValue
`static java.lang.Object`	`applyDisplayValueHint(java.lang.Class<?> target, java.lang.Object initialValue)` as `applyDisplayValueHint(AttributeSensor, Object)`
`static java.lang.Object`	`applyDisplayValueHint(ConfigKey<?> target, java.lang.Object initialValue)` as `applyDisplayValueHint(AttributeSensor, Object)`
`static java.lang.Object`	`applyDisplayValueHintUnchecked(java.lang.Object target, java.lang.Object initialValue)` as `applyDisplayValueHint(AttributeSensor, Object)`, but without type checking; public for those few cases where we may have lost the type
`static <T> RendererHints.DisplayValue<T>`	`censoredValue()` Forces the given sensor or config key's value to be censored.
`static <T> RendererHints.DisplayValue<T>`	`displayValue(com.google.common.base.Function<T,java.lang.String> transform)`
`static java.util.Set<RendererHints.Hint<?>>`	`getHintsFor(AttributeSensor<?> element)` Returns all registered hints against the given element
`static java.util.Set<RendererHints.Hint<?>>`	`getHintsFor(java.lang.Class<?> element)` as `getHintsFor(AttributeSensor)`
`static java.util.Set<RendererHints.Hint<?>>`	`getHintsFor(ConfigKey<?> element)` as `getHintsFor(AttributeSensor)`
`static java.util.Set<RendererHints.Hint<?>>`	`getHintsFor(java.lang.Object element)` Deprecated.
`static java.util.Set<RendererHints.Hint<?>>`	`getHintsFor(java.lang.Object element, java.lang.Class<? extends RendererHints.Hint> optionalHintSuperClass)` Deprecated.
`static <T> RendererHints.NamedActionWithUrl<T>`	`namedActionWithUrl()`
`static <T> RendererHints.NamedActionWithUrl<T>`	`namedActionWithUrl(com.google.common.base.Function<T,java.lang.String> transform)`
`static <T> RendererHints.NamedActionWithUrl<T>`	`namedActionWithUrl(java.lang.String actionName)`
`static <T> RendererHints.NamedActionWithUrl<T>`	`namedActionWithUrl(java.lang.String actionName, com.google.common.base.Function<T,java.lang.String> transform)`
`static <T> RendererHints.NamedActionWithUrl<T>`	`openWithUrl()`
`static <T> RendererHints.NamedActionWithUrl<T>`	`openWithUrl(com.google.common.base.Function<T,java.lang.String> transform)`
`static <T> AttributeSensor<T>`	`register(AttributeSensor<T> element, RendererHints.Hint<? super T> hintForThatElement)` Registers a `RendererHints.Hint` against the given element.
`static <T> java.lang.Class<T>`	`register(java.lang.Class<T> element, RendererHints.Hint<? super T> hintForThatElement)` as `register(AttributeSensor, Hint)`
`static <T> ConfigKey<T>`	`register(ConfigKey<T> element, RendererHints.Hint<? super T> hintForThatElement)` as `register(AttributeSensor, Hint)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RendererHints
```
public RendererHints()
```

Method Detail

register

public static <T> AttributeSensor<T> register(AttributeSensor<T> element,
                              RendererHints.Hint<? super T> hintForThatElement)

Registers a RendererHints.Hint against the given element.

Returns the element, for convenience when used in a with block after defining the element.

register

public static <T> ConfigKey<T> register(ConfigKey<T> element,
                        RendererHints.Hint<? super T> hintForThatElement)

as register(AttributeSensor, Hint)

register

public static <T> java.lang.Class<T> register(java.lang.Class<T> element,
                              RendererHints.Hint<? super T> hintForThatElement)

as register(AttributeSensor, Hint)

getHintsFor

public static java.util.Set<RendererHints.Hint<?>> getHintsFor(AttributeSensor<?> element)

Returns all registered hints against the given element

getHintsFor

public static java.util.Set<RendererHints.Hint<?>> getHintsFor(ConfigKey<?> element)

as getHintsFor(AttributeSensor)

getHintsFor

public static java.util.Set<RendererHints.Hint<?>> getHintsFor(java.lang.Class<?> element)

as getHintsFor(AttributeSensor)

getHintsFor

@Deprecated
public static java.util.Set<RendererHints.Hint<?>> getHintsFor(java.lang.Object element)

Deprecated.

getHintsFor

@Deprecated
public static java.util.Set<RendererHints.Hint<?>> getHintsFor(java.lang.Object element,
                                                          java.lang.Class<? extends RendererHints.Hint> optionalHintSuperClass)

Deprecated.

applyDisplayValueHint

public static java.lang.Object applyDisplayValueHint(AttributeSensor<?> target,
                                     java.lang.Object initialValue)

Applies the (first) display value hint registered against the given target to the given initialValue

applyDisplayValueHint

public static java.lang.Object applyDisplayValueHint(ConfigKey<?> target,
                                     java.lang.Object initialValue)

as applyDisplayValueHint(AttributeSensor, Object)

applyDisplayValueHint

public static java.lang.Object applyDisplayValueHint(java.lang.Class<?> target,
                                     java.lang.Object initialValue)

as applyDisplayValueHint(AttributeSensor, Object)

applyDisplayValueHintUnchecked

@Beta
public static java.lang.Object applyDisplayValueHintUnchecked(java.lang.Object target,
                                                   java.lang.Object initialValue)

as applyDisplayValueHint(AttributeSensor, Object), but without type checking; public for those few cases where we may have lost the type

displayValue

@Beta
public static <T> RendererHints.DisplayValue<T> displayValue(com.google.common.base.Function<T,java.lang.String> transform)

namedActionWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> namedActionWithUrl(java.lang.String actionName,
                                                              com.google.common.base.Function<T,java.lang.String> transform)

namedActionWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> namedActionWithUrl(java.lang.String actionName)

namedActionWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> namedActionWithUrl(com.google.common.base.Function<T,java.lang.String> transform)

namedActionWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> namedActionWithUrl()

openWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> openWithUrl()

openWithUrl

@Beta
public static <T> RendererHints.NamedActionWithUrl<T> openWithUrl(com.google.common.base.Function<T,java.lang.String> transform)

censoredValue
```
@Beta
public static <T> RendererHints.DisplayValue<T> censoredValue()
```
Forces the given sensor or config key's value to be censored. It will be presented as ********.

Class RendererHints

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RendererHints

Method Detail

register

register

register

getHintsFor

getHintsFor

getHintsFor

getHintsFor

getHintsFor

applyDisplayValueHint

applyDisplayValueHint

applyDisplayValueHint

applyDisplayValueHintUnchecked

displayValue

namedActionWithUrl

namedActionWithUrl

namedActionWithUrl

namedActionWithUrl

openWithUrl

openWithUrl

censoredValue