MutableBoundedRangeStatisticImpl (Payara Project 5.2020.5 API)

java.lang.Object
- com.sun.enterprise.admin.monitor.stats.MutableBoundedRangeStatisticImpl

All Implemented Interfaces:

MutableCountStatistic, MutableStatistic, Serializable, javax.management.j2ee.statistics.BoundaryStatistic, javax.management.j2ee.statistics.BoundedRangeStatistic, javax.management.j2ee.statistics.RangeStatistic, javax.management.j2ee.statistics.Statistic
```
public class MutableBoundedRangeStatisticImpl
extends Object
implements javax.management.j2ee.statistics.BoundedRangeStatistic, MutableCountStatistic
```
An implementation of MutableCountStatistic that provides ways to change the state externally through mutators. Convenience class that is useful for components that gather the statistical data. By merely changing the count (which is a mandatory measurement), rest of the statistical information could be deduced.

Since:

S1AS8.0

Version:

1.0

Author:

Kedar Mhaswade

See Also:

for an immutable implementation, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`MutableBoundedRangeStatisticImpl(javax.management.j2ee.statistics.BoundedRangeStatistic initial)` Constructs an instance of MutableCountStatistic that encapsulates the given Statistic.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getCurrent()`
`String`	`getDescription()`
`long`	`getHighWaterMark()`
`long`	`getLastSampleTime()`
`long`	`getLowerBound()`
`long`	`getLowWaterMark()`
`String`	`getName()`
`long`	`getStartTime()`
`String`	`getUnit()`
`long`	`getUpperBound()`
`javax.management.j2ee.statistics.Statistic`	`modifiableView()` Returns an instance of Statistic whose state can be changed by the caller.
`void`	`reset()` Resets to the initial state.
`void`	`setCount(long current)` Changes the current value of the encapsulated BoundedRangeStatistic to the given value.
`void`	`setDescription(String s)`
`javax.management.j2ee.statistics.Statistic`	`unmodifiableView()` This method is the essence of this class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MutableBoundedRangeStatisticImpl
```
public MutableBoundedRangeStatisticImpl(javax.management.j2ee.statistics.BoundedRangeStatistic initial)
```
    Constructs an instance of MutableCountStatistic that encapsulates the given Statistic. The only parameter denotes the initial state of this statistic. It is guaranteed that the initial state is preserved internally, so that one can reset to the initial state.
    
    Parameters:
    
    initial - an instance of BoundedRangeStatistic that represents initial state
- Method Detail
  - reset
```
public void reset()
```
    Resets to the initial state. It is guaranteed that following changes occur to the statistic if this method is called:
    - The current value is reset to initial value.
    - The lastSampleTime is reset to current time in milliseconds.
    - The startTime is reset to lastSampleTime.
    - The highWaterMark is reset to the initial value.
    - The lowWaterMark is reset to the initial value.
    The remaining meta data in the encapsulated statistic is unchanged. The upper and lower bounds are untouched.
    Specified by:
    
    reset in interface MutableStatistic
  - setCount
```
public void setCount(long current)
```
    Changes the current value of the encapsulated BoundedRangeStatistic to the given value. Since this is the only mutator exposed here, here are the other side effects of calling this method:
    - lastSampleTime is set to current time in milliseconds.
    - highWaterMark is accordingly adjusted.
    - lowWaterMark is accordingly adjusted.
    In a real-time system with actual probes for measurement, the lastSampleTime could be different from the instant when this method is called, but that is deemed insignificant.
    Specified by:
    
    setCount in interface MutableCountStatistic
    
    Parameters:
    
    count - long that represents the current value of the Statistic.
  - unmodifiableView
```
public javax.management.j2ee.statistics.Statistic unmodifiableView()
```
    This method is the essence of this class. It provides the read-only view of encapsulated Statistic. If the clients have to know the Statistic, this is what should be called by actual data collecting component to return the value to them. The principle advantage is from the data collecting component's standpoint, in that it does not have to create instances of BoundedRangeStatistic when its current value is queried/measured.
    
    Specified by:
    
    unmodifiableView in interface MutableStatistic
    
    Returns:
    
    instance of BoundedRangeStatistic
    
    See Also:
    
    reset(), setCount(long)
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface javax.management.j2ee.statistics.Statistic
  - getLastSampleTime
```
public long getLastSampleTime()
```
    Specified by:
    
    getLastSampleTime in interface javax.management.j2ee.statistics.Statistic
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface javax.management.j2ee.statistics.Statistic
  - getStartTime
```
public long getStartTime()
```
    Specified by:
    
    getStartTime in interface javax.management.j2ee.statistics.Statistic
  - getUnit
```
public String getUnit()
```
    Specified by:
    
    getUnit in interface javax.management.j2ee.statistics.Statistic
  - modifiableView
```
public javax.management.j2ee.statistics.Statistic modifiableView()
```
    Description copied from interface: MutableStatistic
    
    Returns an instance of Statistic whose state can be changed by the caller. It is important to know that caller should not cache the return value from this method. In general, there is a problem in this contract in that, a client would not know from a Stats.getCreateCount() method whether the return value is something that is being modified or is invariant. Hence the caller should not cache the returned value in a collection and then collectively process it. The main idea behind providing this method is to control the number of instances created (per Mahesh's Suggestion).
    
    Specified by:
    
    modifiableView in interface MutableStatistic
    
    Returns:
    
    an instance of Statistic interface that should not be cached.
  - getCurrent
```
public long getCurrent()
```
    Specified by:
    
    getCurrent in interface javax.management.j2ee.statistics.RangeStatistic
  - getHighWaterMark
```
public long getHighWaterMark()
```
    Specified by:
    
    getHighWaterMark in interface javax.management.j2ee.statistics.RangeStatistic
  - getLowWaterMark
```
public long getLowWaterMark()
```
    Specified by:
    
    getLowWaterMark in interface javax.management.j2ee.statistics.RangeStatistic
  - getLowerBound
```
public long getLowerBound()
```
    Specified by:
    
    getLowerBound in interface javax.management.j2ee.statistics.BoundaryStatistic
  - getUpperBound
```
public long getUpperBound()
```
    Specified by:
    
    getUpperBound in interface javax.management.j2ee.statistics.BoundaryStatistic
  - setDescription
```
public void setDescription(String s)
```

Class MutableBoundedRangeStatisticImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MutableBoundedRangeStatisticImpl

Method Detail

reset

setCount

unmodifiableView

getDescription

getLastSampleTime

getName

getStartTime

getUnit

modifiableView

getCurrent

getHighWaterMark

getLowWaterMark

getLowerBound

getUpperBound

setDescription