BasicSensor (Apache Brooklyn)

java.lang.Object
- brooklyn.event.basic.BasicSensor<T>

All Implemented Interfaces:

Sensor<T>, java.io.Serializable

Direct Known Subclasses:

BasicAttributeSensor, BasicNotificationSensor
```
public class BasicSensor<T>
extends java.lang.Object
implements Sensor<T>
```
Parent for all Sensors.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BasicSensor()`
`BasicSensor(java.lang.Class<T> type, java.lang.String name)` name is typically a dot-separated identifier; description is optional
`BasicSensor(java.lang.Class<T> type, java.lang.String name, java.lang.String description)`
`BasicSensor(com.google.common.reflect.TypeToken<T> typeToken, java.lang.String name, java.lang.String description)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.lang.String`	`getDescription()` Returns the description of the sensor, for display.
`java.lang.String`	`getName()` Returns the name of the sensor, in a dot-separated namespace.
`java.util.List<java.lang.String>`	`getNameParts()` Returns the constituent parts of the sensor name as a `List`.
`java.lang.Class<? super T>`	`getType()` Returns the Java `Class` for the sensor data.
`java.lang.String`	`getTypeName()` Returns the type of the sensor data, as a `String` representation of the class name.
`com.google.common.reflect.TypeToken<T>`	`getTypeToken()` Returns the Guava TypeToken (including generics info)
`int`	`hashCode()`
`SensorEvent<T>`	`newEvent(Entity producer, T value)` Create a new `SensorEvent` object for a specific `Entity` and data point.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BasicSensor
```
public BasicSensor()
```
  - BasicSensor
```
public BasicSensor(java.lang.Class<T> type,
           java.lang.String name)
```
    name is typically a dot-separated identifier; description is optional
  - BasicSensor
```
public BasicSensor(java.lang.Class<T> type,
           java.lang.String name,
           java.lang.String description)
```
  - BasicSensor
```
public BasicSensor(com.google.common.reflect.TypeToken<T> typeToken,
           java.lang.String name,
           java.lang.String description)
```
- Method Detail
  - getTypeToken
```
public com.google.common.reflect.TypeToken<T> getTypeToken()
```
    Description copied from interface: Sensor
    
    Returns the Guava TypeToken (including generics info)
    
    Specified by:
    
    getTypeToken in interface Sensor<T>
    
    See Also:
    Sensor.getTypeToken()
  - getType
```
public java.lang.Class<? super T> getType()
```
    Description copied from interface: Sensor
    
    Returns the Java Class for the sensor data.
    This returns a "super" of T only in the case where T is generified, and in such cases it returns the Class instance for the unadorned T --- i.e. for List<String> this returns Class --- this is of course because there is no actual Class<List<String>> instance.
    
    Specified by:
    
    getType in interface Sensor<T>
    
    See Also:
    Sensor.getType()
  - getTypeName
```
public java.lang.String getTypeName()
```
    Description copied from interface: Sensor
    
    Returns the type of the sensor data, as a String representation of the class name. (Useful for contexts where Type is not accessible.)
    
    Specified by:
    
    getTypeName in interface Sensor<T>
    
    See Also:
    Sensor.getTypeName()
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: Sensor
    
    Returns the name of the sensor, in a dot-separated namespace.
    
    Specified by:
    
    getName in interface Sensor<T>
    
    See Also:
    Sensor.getName()
  - getNameParts
```
public java.util.List<java.lang.String> getNameParts()
```
    Description copied from interface: Sensor
    
    Returns the constituent parts of the sensor name as a List.
    
    Specified by:
    
    getNameParts in interface Sensor<T>
    
    See Also:
    Sensor.getNameParts()
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Sensor
    
    Returns the description of the sensor, for display.
    
    Specified by:
    
    getDescription in interface Sensor<T>
    
    See Also:
    Sensor.getDescription()
  - newEvent
```
public SensorEvent<T> newEvent(Entity producer,
                      T value)
```
    Description copied from interface: Sensor
    
    Create a new SensorEvent object for a specific Entity and data point.
    
    Specified by:
    
    newEvent in interface Sensor<T>
    
    See Also:
    Sensor.newEvent(Entity, Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BasicSensor<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicSensor

BasicSensor

BasicSensor

BasicSensor

Method Detail

getTypeToken

getType

getTypeName

getName

getNameParts

getDescription

newEvent

hashCode

equals

toString