Value.Parameters (statistics 6.154.156 API)

java.lang.Object
- com.yahoo.statistics.Value.Parameters

Enclosing class:

Value
```
public static class Value.Parameters
extends Object
```
Parameters for building Value instances. All settings are classes instead of primitive types to allow tri-state logic (true, false, unset).

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) Character`	`appendChar` Separator character to use between event name and type of nameExtension is set to true.
`(package private) Callback`	`callback` This is invoked each time a value is dumped to the log.
`(package private) HistogramType`	`histogramId` What kind of histogram to log.
`(package private) Limits`	`limits` The limits to use if logging as a histogram.
`(package private) Boolean`	`logHistogram` Log a data histogram.
`(package private) Boolean`	`logInsertions` Log the number of observations for each interval.
`(package private) Boolean`	`logMax` Log the maximal value observed for each interval.
`(package private) Boolean`	`logMean` Log the mean value for each interval.
`(package private) Boolean`	`logMin` Log the minimal value observed for each interval.
`(package private) Boolean`	`logRaw` Log raw values.
`(package private) Boolean`	`logSum` Log the sum of all data points for each interval.
`(package private) Boolean`	`nameExtension` Whether or not to add an identifying extension (like mean) to event names when logging derived values.
`private boolean`	`register` Whether to register in the Statistics manager.

Constructor Summary

Constructors
Constructor and Description

Parameters()
Get a fresh Parameters instance with all features turned/unset.

Constructors
Constructor and Description
`Parameters()` Get a fresh Parameters instance with all features turned/unset.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`merge(Value.Parameters defaults)` If a member is not set in this, add it from defaults.
`Value.Parameters`	`setAppendChar(Character appendChar)` Separator character to use between event name and type of nameExtension is set to true.
`Value.Parameters`	`setCallback(Callback callback)` Set a callback to be invoked each time this Value is written to the log.
`Value.Parameters`	`setHistogramId(HistogramType histogramId)` What kind of histogram to log.
`Value.Parameters`	`setLimits(Limits limits)` The limits to use if logging as a histogram.
`Value.Parameters`	`setLogHistogram(Boolean logHistogram)` (De-)Activate logging a data histogram.
`Value.Parameters`	`setLogInsertions(Boolean logInsertions)` (De-)Activate loging the number of observations for each interval.
`Value.Parameters`	`setLogMax(Boolean logMax)` (De-)Activate logging the maximal value observed for each interval.
`Value.Parameters`	`setLogMean(Boolean logMean)` (De)-activate loging the mean value for each interval.
`Value.Parameters`	`setLogMin(Boolean logMin)` (De-)Activate logging the minimal value observed for each interval.
`Value.Parameters`	`setLogRaw(Boolean logRaw)` (De-)Activate logging of raw values.
`Value.Parameters`	`setLogSum(Boolean logSum)` (De-)Activate logging the sum of all data points for each interval.
`Value.Parameters`	`setNameExtension(Boolean nameExtension)` Whether or not to add an identifying extension (like mean) to event names when logging derived values.
`private Value.Parameters`	`setRegister(boolean register)` Set whether to register in the statistics manager.

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

- Field Detail
  - logRaw
```
Boolean logRaw
```
    Log raw values. Raw values are basically the last value logged.
  - logSum
```
Boolean logSum
```
    Log the sum of all data points for each interval.
  - logMean
```
Boolean logMean
```
    Log the mean value for each interval.
  - logMax
```
Boolean logMax
```
    Log the maximal value observed for each interval.
  - logMin
```
Boolean logMin
```
    Log the minimal value observed for each interval.
  - logInsertions
```
Boolean logInsertions
```
    Log the number of observations for each interval.
  - nameExtension
```
Boolean nameExtension
```
    Whether or not to add an identifying extension (like mean) to event names when logging derived values. It is useful to disable extensions if a only a single dervied value, e.g. the mean, is the only thing to be logged. The default is to use extensions. If extensions are disabled, the ability to log more than one of raw value, min, max, mean (i.e. the raw value and derived values of the same type) is disabled to avoid confusion. Since histograms are not Value events, these never have a name extension and are always available.
  - logHistogram
```
Boolean logHistogram
```
    Log a data histogram.
  - histogramId
```
HistogramType histogramId
```
    What kind of histogram to log.
    
    See Also:
    
    HistogramType
  - limits
```
Limits limits
```
    The limits to use if logging as a histogram. The Limits instance must be frozen before using the Parameters instance in a Value constructor call.
    
    See Also:
    
    Limits
  - appendChar
```
Character appendChar
```
    Separator character to use between event name and type of nameExtension is set to true.
  - callback
```
Callback callback
```
    This is invoked each time a value is dumped to the log.
    
    See Also:
    
    Handle.runCallback()
  - register
```
private boolean register
```
    Whether to register in the Statistics manager. This is not touched by merge and also has no undefined state. In general, a Value should always register and not doing so explicitly should not be part of the public API.
- Constructor Detail
  - Parameters
```
public Parameters()
```
    Get a fresh Parameters instance with all features turned/unset. Parameters instances may be recycled for construction multiple Value instances, but do note any Limits instance added must be frozen.
- Method Detail
  - setLogRaw
```
public Value.Parameters setLogRaw(Boolean logRaw)
```
    (De-)Activate logging of raw values. Raw values are basically the last value logged.
    
    Returns:
    
    "this" for call chaining
  - setLogSum
```
public Value.Parameters setLogSum(Boolean logSum)
```
    (De-)Activate logging the sum of all data points for each interval.
    
    Returns:
    
    "this" for call chaining
  - setLogMean
```
public Value.Parameters setLogMean(Boolean logMean)
```
    (De)-activate loging the mean value for each interval.
    
    Returns:
    
    "this" for call chaining
  - setLogMax
```
public Value.Parameters setLogMax(Boolean logMax)
```
    (De-)Activate logging the maximal value observed for each interval.
    
    Returns:
    
    "this" for call chaining
  - setLogMin
```
public Value.Parameters setLogMin(Boolean logMin)
```
    (De-)Activate logging the minimal value observed for each interval.
    
    Returns:
    
    "this" for call chaining
  - setLogInsertions
```
public Value.Parameters setLogInsertions(Boolean logInsertions)
```
    (De-)Activate loging the number of observations for each interval.
    
    Returns:
    
    "this" for call chaining
  - setNameExtension
```
public Value.Parameters setNameExtension(Boolean nameExtension)
```
    Whether or not to add an identifying extension (like mean) to event names when logging derived values. It is useful to disable extensions if a only a single dervied value, e.g. the mean, is the only thing to be logged. The default is to use extensions. If extensions are disabled, the ability to log more than one of raw value, min, max, mean (i.e. the raw value and derived values of the same type) is disabled to avoid confusion. Since histograms are not Value events, these never have a name extension and are always available.
    
    Returns:
    
    "this" for call chaining
  - setLogHistogram
```
public Value.Parameters setLogHistogram(Boolean logHistogram)
```
    (De-)Activate logging a data histogram.
    
    Returns:
    
    "this" for call chaining
  - setHistogramId
```
public Value.Parameters setHistogramId(HistogramType histogramId)
```
    What kind of histogram to log.
    
    Returns:
    
    "this" for call chaining
    
    See Also:
    
    HistogramType
  - setLimits
```
public Value.Parameters setLimits(Limits limits)
```
    The limits to use if logging as a histogram. The Limits instance must be frozen before using the Parameters instance in a Value constructor call.
    
    Returns:
    
    "this" for call chaining*
    
    See Also:
    
    Limits
  - setAppendChar
```
public Value.Parameters setAppendChar(Character appendChar)
```
    Separator character to use between event name and type of nameExtension is set to true. The default is '.'.
    
    Returns:
    
    "this" for call chaining
  - setCallback
```
public Value.Parameters setCallback(Callback callback)
```
    Set a callback to be invoked each time this Value is written to the log.
    
    Parameters:
    
    callback - to be invoked each time the Value is written to the log
    
    Returns:
    
    "this" for call chaining
  - setRegister
```
private Value.Parameters setRegister(boolean register)
```
    Set whether to register in the statistics manager. Do note the package private access for this method opposed to all the other setters.
    
    Parameters:
    
    register - set to false to avoid registering
    
    Returns:
    
    "this" for call chaining
  - merge
```
void merge(Value.Parameters defaults)
```
    If a member is not set in this, add it from defaults. Do note, this applies for both true and false settings, in other words, the default may also be used to turn off something if it is undefined in this.

Class Value.Parameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logRaw

logSum

logMean

logMax

logMin

logInsertions

nameExtension

logHistogram

histogramId

limits

appendChar

callback

register

Constructor Detail

Parameters

Method Detail

setLogRaw

setLogSum

setLogMean

setLogMax

setLogMin

setLogInsertions

setNameExtension

setLogHistogram

setHistogramId

setLimits

setAppendChar

setCallback

setRegister

merge