org.hawkular.inventory.api.model

Class MetricType

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement<B,U>

org.hawkular.inventory.api.model.Entity<B,U>

org.hawkular.inventory.api.model.TenantBasedEntity<MetricType.Blueprint,MetricType.Update>

org.hawkular.inventory.api.model.MetricType

public final class MetricType
extends TenantBasedEntity<MetricType.Blueprint,MetricType.Update>

Metric type defines metadata of metrics of the same type. Metric types are owned by resource types in the same way as metrics are owned by resources (i.e. multiple resource types can "own" a single metric type).

Author:

Heiko W. Rupp, Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricType.Blueprint Data required to create a new metric type.
static class	MetricType.Update

Nested classes/interfaces inherited from class org.hawkular.inventory.api.model.AbstractElement

AbstractElement.Updater<U extends AbstractElement.Update,E extends AbstractElement<?,U>>

Field Summary

Fields inherited from class org.hawkular.inventory.api.model.AbstractElement

ID_PROPERTY, properties

Constructor Summary

Constructors

Constructor and Description
MetricType(CanonicalPath path)
MetricType(CanonicalPath path, MetricUnit unit, MetricDataType type)
MetricType(CanonicalPath path, MetricUnit unit, MetricDataType type, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> visitor, P parameter) Accepts the provided visitor.
protected void	appendToString(StringBuilder toStringBuilder) Use this to append additional information to the string representation of this instance returned from the (final) Entity.toString().
MetricDataType	getType()
MetricUnit	getUnit()
AbstractElement.Updater<MetricType.Update,MetricType>	update()

Methods inherited from class org.hawkular.inventory.api.model.TenantBasedEntity

getTenantId

Methods inherited from class org.hawkular.inventory.api.model.Entity

toString

Methods inherited from class org.hawkular.inventory.api.model.AbstractElement

equals, getId, getPath, getProperties, hashCode, valueOrDefault

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricType

public MetricType(CanonicalPath path)

MetricType

public MetricType(CanonicalPath path,
                  MetricUnit unit,
                  MetricDataType type)

MetricType

public MetricType(CanonicalPath path,
                  MetricUnit unit,
                  MetricDataType type,
                  Map<String,Object> properties)

Method Detail

getUnit

public MetricUnit getUnit()

getType

public MetricDataType getType()

update

public AbstractElement.Updater<MetricType.Update,MetricType> update()

Specified by:

update in class AbstractElement<MetricType.Blueprint,MetricType.Update>

Returns:

a new updater object to modify this entity and produce a new one.

accept

public <R,P> R accept(ElementVisitor<R,P> visitor,
                      P parameter)

Description copied from class: AbstractElement

Accepts the provided visitor.

Specified by:

accept in class AbstractElement<MetricType.Blueprint,MetricType.Update>

Type Parameters:

R - the return type

P - the type of the parameter

Parameters:

visitor - the visitor to visit this entity

parameter - the parameter to pass on to the visitor

Returns:

the return value provided by the visitor

appendToString

protected void appendToString(StringBuilder toStringBuilder)

Description copied from class: Entity

Use this to append additional information to the string representation of this instance returned from the (final) Entity.toString().

Generally, one should call the super method first and then only add additional information to the builder.

Overrides:

appendToString in class Entity<MetricType.Blueprint,MetricType.Update>

Parameters:

toStringBuilder - the builder to append stuff to.