org.hawkular.inventory.api.model

Class Metric

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement

org.hawkular.inventory.api.model.Entity

org.hawkular.inventory.api.model.Metric

public final class Metric
extends Entity

Metric describes a single metric that is sent out from a feed. Each metric has a unique ID and a type. Metrics live in an environment and can be "incorporated" by resources (surprisingly, many resources can incorporate a single metric).

Since:

0.0.1

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

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

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
Metric(CanonicalPath path, MetricType type)
Metric(CanonicalPath path, MetricType type, Long collectionInterval)
Metric(CanonicalPath path, MetricType type, Map<String,Object> properties)
Metric(String name, CanonicalPath path, MetricType type)
Metric(String name, CanonicalPath path, MetricType type, Long collectionInterval, 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().
Long	getCollectionInterval()
MetricType	getType()

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

Metric

public Metric(CanonicalPath path,
              MetricType type)

Metric

public Metric(String name,
              CanonicalPath path,
              MetricType type)

Metric

public Metric(CanonicalPath path,
              MetricType type,
              Long collectionInterval)

Metric

public Metric(CanonicalPath path,
              MetricType type,
              Map<String,Object> properties)

Metric

public Metric(String name,
              CanonicalPath path,
              MetricType type,
              Long collectionInterval,
              Map<String,Object> properties)

Method Detail

getType

public MetricType getType()

getCollectionInterval

public Long getCollectionInterval()

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.

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