|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InstrumentSampleDescriptor
Describes an InstrumentSample and acts as a Proxy to protect the original InstrumentSample object.
Method Summary | |
---|---|
void |
addInstrumentSampleListener(InstrumentSampleListener listener)
Registers a InstrumentSampleListener with a InstrumentSample given a name. |
long |
extendLease(long lease)
Extends the lease to be lease milliseconds from the current time. |
java.lang.String |
getDescription()
Returns the description of the sample. |
InstrumentDescriptor |
getInstrumentDescriptor()
Returns a reference to the descriptor of the Instrument of the sample. |
int |
getInstrumentType()
Returns the Type of the Instrument which can use the sample. |
long |
getInterval()
Returns the sample interval. |
long |
getLeaseExpirationTime()
Returns the time that the current lease expires. |
java.lang.String |
getName()
Returns the name of the sample. |
int |
getSize()
Returns the number of samples in the sample history. |
InstrumentSampleSnapshot |
getSnapshot()
Obtains a static snapshot of the InstrumentSample. |
int |
getStateVersion()
Returns the stateVersion of the sample. |
long |
getTime()
Obtain the UNIX time of the beginning of the sample. |
int |
getType()
Returns the type of the Instrument Sample. |
int |
getValue()
Obtain the value of the sample. |
boolean |
isConfigured()
Returns true if the InstrumentSample was configured in the instrumentables section of the configuration. |
void |
removeInstrumentSampleListener(InstrumentSampleListener listener)
Unregisters a InstrumentSampleListener from a InstrumentSample given a name. |
Method Detail |
---|
boolean isConfigured()
java.lang.String getName()
long getInterval()
int getSize()
java.lang.String getDescription()
int getType()
int getValue()
long getTime()
int getInstrumentType()
Should be one of the following: InstrumentManager.PROFILE_POINT_TYPE_COUNTER or InstrumentManager.PROFILE_POINT_TYPE_VALUE
InstrumentDescriptor getInstrumentDescriptor()
void addInstrumentSampleListener(InstrumentSampleListener listener)
listener
- The listener which should start receiving updates from the
InstrumentSample.void removeInstrumentSampleListener(InstrumentSampleListener listener)
listener
- The listener which should stop receiving updates from the
InstrumentSample.long getLeaseExpirationTime()
long extendLease(long lease)
lease
- The length of the lease in milliseconds.
InstrumentSampleSnapshot getSnapshot()
int getStateVersion()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |