OSGi 8.1.0 · org.osgi.service.resourcemonitoring.ResourceEvent

Field Summary

Modifier and Type	Field and Description
public static final int	ERROR Type of ResourceEvent indicating a threshold goes to the ERROR state.
private final boolean	isUpperThreshold
public static final int	NORMAL Type of ResourceEvent indicating a threshold goes to the NORMAL state.
private final ResourceContext	resourceContext
private final int	type
private final Comparable<T>	value
public static final int	WARNING Type of ResourceEvent indicating a threshold goes to the WARNING state.

Constructor Summary

Access	Constructor and Description
public	ResourceEvent(final int the event type pType, final ResourceContext the resource context pContext, final boolean whether it is an upper threshold pIsUpperThreshold, final Comparable<T> the value pValue) Creates a new ResourceEvent.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. var0) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public ResourceContext	Returns: The resource context that caused the event. getContext() Returns the resource context that caused the event.
public int	Returns: The event type getType() Returns the event type.
public Comparable<T>	Returns: the resource consumption value, or null if a resource monitor is not relevant. getValue() Returns the resource consumption value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: true if it is an upper threshold. isUpperThreshold() Returns true if the threshold triggering this event is an upper threshold.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

ERROR	back to summary
public static final int ERROR Type of ResourceEvent indicating a threshold goes to the ERROR state.

isUpperThreshold	back to summary
private final boolean isUpperThreshold

NORMAL	back to summary
public static final int NORMAL Type of ResourceEvent indicating a threshold goes to the NORMAL state.

resourceContext	back to summary
private final ResourceContext resourceContext

type	back to summary
private final int type

value	back to summary
private final Comparable<T> value

WARNING	back to summary
public static final int WARNING Type of ResourceEvent indicating a threshold goes to the WARNING state.

Constructor Detail

ResourceEvent	back to summary
public ResourceEvent(final int pType, final ResourceContext pContext, final boolean pIsUpperThreshold, final Comparable<T> pValue) Creates a new ResourceEvent. Parameters pType:int the event type pContext:ResourceContext the resource context pIsUpperThreshold:boolean whether it is an upper threshold pValue:Comparable<T> the value

ResourceEvent

back to summary

public ResourceEvent(final int pType, final ResourceContext pContext, final boolean pIsUpperThreshold, final Comparable<T> pValue)

Creates a new ResourceEvent.

Parameters

pType:int: the event type
pContext:ResourceContext: the resource context
pIsUpperThreshold:boolean: whether it is an upper threshold
pValue:Comparable<T>: the value

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object var0) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters var0:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object var0)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

var0:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getContext	back to summary
public ResourceContext getContext() Returns the resource context that caused the event. Returns:ResourceContext The resource context that caused the event.

getContext

back to summary

public ResourceContext getContext()

Returns the resource context that caused the event.

Returns:ResourceContext: The resource context that caused the event.

getType back to summary

getType	back to summary
public int getType() Returns the event type. The type values are: `NORMAL` `WARNING` `ERROR` Returns:int The event type

public int getType()

Returns the event type. The type values are:

Returns:int: The event type

getValue back to summary

getValue	back to summary
public Comparable<T> getValue() Returns the resource consumption value. Relevant only for event types `NORMAL`, `WARNING` and `ERROR`. Returns:Comparable<T> the resource consumption value, or null if a resource monitor is not relevant.

public Comparable<T> getValue()

Returns the resource consumption value. Relevant only for event types NORMAL, WARNING and ERROR.

Returns:Comparable<T>: the resource consumption value, or null if a resource monitor is not relevant.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isUpperThreshold back to summary

isUpperThreshold	back to summary
public boolean isUpperThreshold() Returns true if the threshold triggering this event is an upper threshold. This method is only used when `getType()` returns `NORMAL`, `WARNING` or `ERROR`. Returns:boolean true if it is an upper threshold.

public boolean isUpperThreshold()

Returns true if the threshold triggering this event is an upper threshold. This method is only used when getType() returns NORMAL, WARNING or ERROR.

Returns:boolean: true if it is an upper threshold.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class ResourceEvent<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail