Module aeonics.core

Package aeonics.entity

Class Probe

java.lang.Object

aeonics.template.Item<Probe.Type>

aeonics.entity.Probe

public class Probe
extends Item<Probe.Type>

A probe represents any type of information that can be fetched at any point in time. Usually this is used for system metrics, counters or current state.

There is no requrement in terms of data structure or allowed values.

Unless overriden, a probe is always internal (Entity.internal()).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Probe.Type

Constructor Summary

Constructors

Constructor	Description
Probe()

Method Summary

Modifier and Type	Method	Description
protected java.lang.Class<? extends Probe>	category()	Returns the target entity category.
protected java.util.function.Supplier<? extends Probe.Type>	defaultCreator()	Returns the default target entity creator.
protected java.lang.Class<? extends Probe.Type>	defaultTarget()	Returns the default target entity type.
Template<? extends Probe.Type>	template()	Returns the template to build the target entity.

Methods inherited from class aeonics.template.Item

creator, creator, defaultType, from, target, target, type, type

Methods inherited from class java.lang.Object

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

Constructor Detail

Probe

public Probe()

Method Detail

defaultTarget

protected java.lang.Class<? extends Probe.Type> defaultTarget()

Description copied from class: Item

Returns the default target entity type. This method should be implemented by subclasses to specify the target entity type.

Specified by:

defaultTarget in class Item<Probe.Type>

Returns:

the default target entity type

defaultCreator

protected java.util.function.Supplier<? extends Probe.Type> defaultCreator()

Description copied from class: Item

Returns the default target entity creator. This method should be implemented by subclasses to specify the entity creator.

Specified by:

defaultCreator in class Item<Probe.Type>

Returns:

the default target entity creator

category

protected java.lang.Class<? extends Probe> category()

Description copied from class: Item

Returns the target entity category. This method should be implemented by subclasses to specify the entity category.

Specified by:

category in class Item<Probe.Type>

Returns:

the target entity category

template

public Template<? extends Probe.Type> template()

Description copied from class: Item

Returns the template to build the target entity.

This method should ultimately be used to provide the final entity template. Although, it may also provide a partial template that subclassed may complement.

Overrides:

template in class Item<Probe.Type>

Returns:

the matching entity template