Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.data

Class PrometheusDataTouch

java.lang.Object

io.github.tonywasher.joceanus.prometheus.data.PrometheusDataTouch

All Implemented Interfaces:

MetisDataItem.MetisDataMap<MetisListKey,PrometheusDataTouch.PrometheusTouchCounter>, MetisDataItem.MetisDataObjectFormat

public class PrometheusDataTouch
extends Object
implements MetisDataItem.MetisDataObjectFormat, MetisDataItem.MetisDataMap<MetisListKey,PrometheusDataTouch.PrometheusTouchCounter>

Class to record reference to a DataItem via another data item.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PrometheusDataTouch.PrometheusTouchCounter	Simple counter.

Constructor Summary

Constructors

Constructor	Description
PrometheusDataTouch()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	copyMap(PrometheusDataTouch pSource)	Constructor.
String	formatObject(OceanusDataFormatter pFormatter)	Obtain Object summary.
PrometheusDataTouch.PrometheusTouchCounter	getCounter(MetisListKey pItemType)	Obtain item count.
Map<MetisListKey,PrometheusDataTouch.PrometheusTouchCounter>	getUnderlyingMap()	Obtain underlying map.
boolean	isActive()	Is the item active.
Iterator<PrometheusDataTouch.PrometheusTouchCounter>	iterator()	Obtain iterator.
void	resetTouches()	Reset all touches.
void	resetTouches(MetisListKey pItemType)	Reset touches for a dataType.
boolean	touchedBy(MetisListKey pItemType)	Is the item touched by the ItemType?
void	touchItem(MetisListKey pItemType)	Touch an item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataMap

get, isEmpty, put, size

Constructor Details

PrometheusDataTouch

public PrometheusDataTouch()

Constructor.

Method Details

getUnderlyingMap

public Map<MetisListKey,PrometheusDataTouch.PrometheusTouchCounter> getUnderlyingMap()

Description copied from interface: MetisDataItem.MetisDataMap

Obtain underlying map.

Specified by:

getUnderlyingMap in interface MetisDataItem.MetisDataMap<MetisListKey,PrometheusDataTouch.PrometheusTouchCounter>

Returns:

the map

formatObject

public String formatObject(OceanusDataFormatter pFormatter)

Description copied from interface: MetisDataItem.MetisDataObjectFormat

Obtain Object summary.

Specified by:

formatObject in interface MetisDataItem.MetisDataObjectFormat

Parameters:

pFormatter - the data formatter

Returns:

the display summary of the object

copyMap

protected void copyMap(PrometheusDataTouch pSource)

Constructor.

Parameters:

pSource - the source map

resetTouches

public void resetTouches()

Reset all touches.

resetTouches

public void resetTouches(MetisListKey pItemType)

Reset touches for a dataType.

Parameters:

pItemType - the ItemType

touchItem

public void touchItem(MetisListKey pItemType)

Touch an item.

Parameters:

pItemType - the item type

touchedBy

public boolean touchedBy(MetisListKey pItemType)

Is the item touched by the ItemType?

Parameters:

pItemType - the item type

Returns:

true/false

isActive

public boolean isActive()

Is the item active.

Returns:

true/false

getCounter

public PrometheusDataTouch.PrometheusTouchCounter getCounter(MetisListKey pItemType)

Obtain item count.

Parameters:

pItemType - the item type

Returns:

the counter (or null)

iterator

public Iterator<PrometheusDataTouch.PrometheusTouchCounter> iterator()

Obtain iterator.

Returns:

the iterator