FileMetric (Simple Metrics 1.8 API)

java.lang.Object
- com.j256.simplemetrics.utils.FileMetric

```
public class FileMetric
extends Object
```
Metric read from a file on the file-system. Often used to read from the /proc file-system under Linux. You can use regular-expression, line prefix string, or line-number to specify which line from the file that you want to process. In terms of extracting the value from fields, you can use a regular-expression to split the line into columns and then set the column that you want. If you are matching the line with a regular-expression, the column number will correspond to a () group-number.
You can also adjust the extracted value using an adjustment operation and value. For example, the value in the file might be the number of 512 byte sectors when you really want the metric to reflect bytes. You could then use the FileMetric.FileMetricOperation.MULTIPLY adjustment-operation and an adjustment-value of 512.

Author:

graywatson

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileMetric.FileMetricKind` Kind of metrics that we are processing here.
`static class`	`FileMetric.FileMetricOperation` Adjustment operations that can be used to adjust the extracted value by using `setAdjustmentOperation(FileMetricOperation)`.

Constructor Summary

Constructors
Constructor and Description
`FileMetric()`
`FileMetric(String metricName, String metricComponent, String metricModule, String description, File metricFile, FileMetric.FileMetricKind kind, int column, String lineSplit, String prefix)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ControlledMetric<?,?>`	`getMetric()` Get the associated metric whole value is set from the file.
`void`	`initialize()` Should be called after all of the setter methods are called, maybe my Spring init mechanism?
`boolean`	`isInitialized()` If the metric has been initialized with the `initialize()` method.
`void`	`setAdjustmentOperation(FileMetric.FileMetricOperation adjustmentOperation)` If you need to adjust the extracted value, this sets the operation that will be applied with the `setAdjustmentValue(double)`.
`void`	`setAdjustmentValue(double adjustmentValueDouble)` Set the adjustment value as a floating point value.
`void`	`setAdjustmentValue(long adjustmentValueLong)` Set the adjustment value as a long integer.
`void`	`setColumn(int column)` The column from a split perspective (0 to N-1) or the matcher.group(column) if using the line-pattern regex.
`void`	`setDecimalNumber(boolean decimalNumber)` Set to true to make this value be represented internally as a long decimal number.
`void`	`setDescription(String description)` The description to be associated with the metric.
`void`	`setKind(FileMetric.FileMetricKind kind)` The kind of the metric.
`void`	`setLineNumber(int lineNumber)` Number of the line in the file to process.
`void`	`setLinePattern(String linePattern)` Set the regex pattern that should match the line.
`void`	`setLineSplit(String lineSplit)` Regex string to use to divide the line up into fields so we can use the column to extract one of the fields.
`void`	`setMetricComponent(String metricComponent)` The component to be associated with the metric.
`void`	`setMetricFile(String metricFile)` The file that we process to find the value.
`void`	`setMetricFiles(String[] metricFiles)` An array of files that that will be looked at.
`void`	`setMetricModule(String metricModule)` The module to be associated with the metric.
`void`	`setMetricName(String metricName)` The name to be associated with the metric.
`void`	`setPrefix(String prefix)` Prefix string to look for in the file.
`void`	`setRequired(boolean required)` Set whether or not this metric is required, default is false.
`void`	`setUnit(String unit)` The unit to be associated with the metric.
`String`	`toString()`
`void`	`updateValue()` Update the value in the metric.

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

- Constructor Detail
  - FileMetric
```
public FileMetric()
```
  - FileMetric
```
public FileMetric(String metricName,
                  String metricComponent,
                  String metricModule,
                  String description,
                  File metricFile,
                  FileMetric.FileMetricKind kind,
                  int column,
                  String lineSplit,
                  String prefix)
           throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
- Method Detail
  - initialize
```
public void initialize()
                throws IllegalArgumentException
```
    Should be called after all of the setter methods are called, maybe my Spring init mechanism?
    
    Throws:
    
    IllegalArgumentException
  - updateValue
```
public void updateValue()
                 throws IOException
```
    Update the value in the metric.
    
    Throws:
    
    IOException
  - getMetric
```
public ControlledMetric<?,?> getMetric()
```
    Get the associated metric whole value is set from the file.
  - isInitialized
```
public boolean isInitialized()
```
    If the metric has been initialized with the initialize() method.
  - setMetricFile
```
public void setMetricFile(String metricFile)
```
    The file that we process to find the value. Either this or setMetricFiles(String[]) must be specified.
  - setMetricFiles
```
public void setMetricFiles(String[] metricFiles)
```
    An array of files that that will be looked at. The first one that exists will be used. Either this or setMetricFile(String) must be specified.
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name to be associated with the metric. See ControlledMetric.getName().
  - setMetricComponent
```
public void setMetricComponent(String metricComponent)
```
    The component to be associated with the metric. See ControlledMetric.getComponent().
  - setMetricModule
```
public void setMetricModule(String metricModule)
```
    The module to be associated with the metric. See ControlledMetric.getModule().
  - setDescription
```
public void setDescription(String description)
```
    The description to be associated with the metric. See ControlledMetric.getDescription().
  - setUnit
```
public void setUnit(String unit)
```
    The unit to be associated with the metric. See ControlledMetric.getUnit().
  - setKind
```
public void setKind(FileMetric.FileMetricKind kind)
```
    The kind of the metric. See FileMetric.FileMetricKind.
  - setColumn
```
public void setColumn(int column)
```
    The column from a split perspective (0 to N-1) or the matcher.group(column) if using the line-pattern regex. With the regex, the 0th group is the entire matched string and the 1st group is the first () in the pattern.
  - setLineSplit
```
public void setLineSplit(String lineSplit)
```
    Regex string to use to divide the line up into fields so we can use the column to extract one of the fields. Default is a single space.
  - setLinePattern
```
public void setLinePattern(String linePattern)
```
    Set the regex pattern that should match the line. The column then becomes the group-number from the regex matcher.
  - setPrefix
```
public void setPrefix(String prefix)
```
    Prefix string to look for in the file. If this is set then the line won't match unless this prefix is seen.
  - setRequired
```
public void setRequired(boolean required)
```
    Set whether or not this metric is required, default is false. If the file doesn't exist on this system and it is required then this will cause an exception to be thrown.
  - setAdjustmentValue
```
public void setAdjustmentValue(long adjustmentValueLong)
```
    Set the adjustment value as a long integer. If you need to adjust the extracted value at all, you can use this adjustment combined with the setAdjustmentOperation(FileMetricOperation) method to change the value after it is extracted from the file. You can also specify it as a double by calling #setAdjustmentValue(double)).
  - setAdjustmentValue
```
public void setAdjustmentValue(double adjustmentValueDouble)
```
    Set the adjustment value as a floating point value. If you need to adjust the extracted value at all, you can use this adjustment combined with the setAdjustmentOperation(FileMetricOperation) method to change the value after it is extracted from the file. You can also specify it as a long by calling setAdjustmentValue(long).
  - setAdjustmentOperation
```
public void setAdjustmentOperation(FileMetric.FileMetricOperation adjustmentOperation)
```
    If you need to adjust the extracted value, this sets the operation that will be applied with the setAdjustmentValue(double).
  - setLineNumber
```
public void setLineNumber(int lineNumber)
```
    Number of the line in the file to process. The first line in the file is #1 not 0.
  - setDecimalNumber
```
public void setDecimalNumber(boolean decimalNumber)
```
    Set to true to make this value be represented internally as a long decimal number. Default is false which will represent it as a double floating point.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FileMetric

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileMetric

FileMetric

Method Detail

initialize

updateValue

getMetric

isInitialized

setMetricFile

setMetricFiles

setMetricName

setMetricComponent

setMetricModule

setDescription

setUnit

setKind

setColumn

setLineSplit

setLinePattern

setPrefix

setRequired

setAdjustmentValue

setAdjustmentValue

setAdjustmentOperation

setLineNumber

setDecimalNumber

toString