Class Overview
An abstract sensor.
A AbstractSensor object consists of two attributes:
- on is a boolean flag indicating if a sensor is
triggered. This flag will be set or cleared by the
component that owns the sensor.
- count is the total number of times that a sensor
has been triggered.
Summary
Public Constructors |
|
Sensor(String name)
Constructs a Sensor object.
|
Public Methods |
void
|
clear()
Clears this sensor.
|
void
|
clear(int increment)
Clears this sensor
and increments the count with the input increment.
|
long
|
getCount()
Returns the total number of times that this sensor has been triggered.
|
String
|
getName()
Returns the name of this sensor.
|
boolean
|
isOn()
Tests if this sensor is currently on.
|
String
|
toString()
Returns a string representation of the object.
|
void
|
trigger(int increment)
Triggers this sensor.
|
void
|
trigger(int increment, MemoryUsage usage)
Triggers this sensor piggybacking a memory usage object.
|
void
|
trigger()
Triggers this sensor.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
Public Constructors
public
Sensor
(String name)
Constructs a Sensor object.
Parameters
name
| The name of this sensor.
|
Public Methods
public
void
clear
(int increment)
Clears this sensor
and increments the count with the input increment.
public
long
getCount
()
Returns the total number of times that this sensor has been triggered.
Returns
- the total number of times that this sensor has been triggered.
public
String
getName
()
Returns the name of this sensor.
public
boolean
isOn
()
Tests if this sensor is currently on.
Returns
- true if the sensor is currently on;
false otherwise.
public
String
toString
()
Returns a string representation of the object. In general, the
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns
- a string representation of the object.
public
void
trigger
(int increment)
Triggers this sensor. This method sets this sensor on
and increments the count with the input increment.
public
void
trigger
(int increment, MemoryUsage usage)
Triggers this sensor piggybacking a memory usage object.
This method sets this sensor on
and increments the count with the input increment.
public
void
trigger
()
Triggers this sensor. This method first sets this sensor on
and increments its sensor count.