org.hawkular.inventory.api.model

Class MetricType

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement

org.hawkular.inventory.api.model.Entity

org.hawkular.inventory.api.model.MetricType

public final class MetricType
extends Entity

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.

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentType	SEGMENT_TYPE

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

properties

Constructor Summary

Constructors

Constructor and Description
MetricType(CanonicalPath path)
MetricType(CanonicalPath path, MetricUnit unit, MetricDataType metricDataType)
MetricType(CanonicalPath path, MetricUnit unit, MetricDataType metricDataType, Long collectionInterval)
MetricType(CanonicalPath path, MetricUnit unit, MetricDataType metricDataType, Map<String,Object> properties, Long collectionInterval)
MetricType(String name, CanonicalPath path, MetricUnit unit, MetricDataType metricDataType)
MetricType(String name, CanonicalPath path, MetricUnit unit, MetricDataType metricDataType, Map<String,Object> properties, Long collectionInterval)

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().
Long	getCollectionInterval()
MetricDataType	getMetricDataType()
MetricDataType	getType() Deprecated. use getMetricDataType() insteads
MetricUnit	getUnit()

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

entityTypeFromSegmentType, getName, toString, typeFromSegmentType

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

equals, getId, getPath, getProperties, hashCode, segmentTypeFromType, toElementClass

Methods inherited from class java.lang.Object

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

Field Detail

SEGMENT_TYPE

public static final SegmentType SEGMENT_TYPE

Constructor Detail

MetricType

public MetricType(CanonicalPath path)

MetricType

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

MetricType

public MetricType(CanonicalPath path,
                  MetricUnit unit,
                  MetricDataType metricDataType,
                  Long collectionInterval)

MetricType

public MetricType(String name,
                  CanonicalPath path,
                  MetricUnit unit,
                  MetricDataType metricDataType)

MetricType

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

MetricType

public MetricType(String name,
                  CanonicalPath path,
                  MetricUnit unit,
                  MetricDataType metricDataType,
                  Map<String,Object> properties,
                  Long collectionInterval)

Method Detail

getUnit

public MetricUnit getUnit()

getMetricDataType

public MetricDataType getMetricDataType()

getType

@Deprecated
public MetricDataType getType()

Deprecated. use getMetricDataType() insteads

This will disappear in due time.

Returns:

the metric data type

getCollectionInterval

public Long getCollectionInterval()

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

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

Parameters:

toStringBuilder - the builder to append stuff to.