MonitoringGroupSettings

java.lang.Object
- de.uni_hildesheim.sse.monitoring.runtime.boot.MonitoringGroupSettings

```
public class MonitoringGroupSettings
extends java.lang.Object
```
Helper class to transfer the values of a monitoring group (also compiled in instrumented code) to the recorder. Be careful: Due to the JVM init and load process, neither annotation instances nor the global configuration may be used here.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type	Field and Description
`private BooleanValue`	`considerContained` Stores whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
`private DebugState[]`	`debugStates` Returns a combination of debug states for additional information to be emitted during monitoring.
`private BooleanValue`	`distributeValues` Stores whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
`private GroupAccountingType`	`gType` Stores the group accounting to be applied.
`private java.lang.String[]`	`id` Contains arbitrary ids for monitoring and grouping.
`private InstanceIdentifierKind`	`instanceIdentifierKind` Stores the instance identifier kind.
`private static ArrayList<MonitoringGroupSettings>`	`POOL` Stores instances of this class for reuse.
`private ResourceType[]`	`resources` Stores the resources to be accounted.

Constructor Summary

Constructors
Modifier Constructor and Description

private MonitoringGroupSettings()
Creates a new instance.

Constructors
Modifier	Constructor and Description
`private`	`MonitoringGroupSettings()` Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Cleans the attributes of this instance.
`MonitoringGroupSettings`	`create()` Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).
`GroupAccountingType`	`getAccountingType()` Returns the group accounting to be applied.
`BooleanValue`	`getConsiderContained()` Returns whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
`DebugState[]`	`getDebugStates()` Returns a combination of debug states for additional information to be emitted during monitoring.
`BooleanValue`	`getDistributeValues()` Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
`static MonitoringGroupSettings`	`getFromPool()` Returns an instance from the shared pool.
`java.lang.String[]`	`getId()` Contains arbitrary ids for monitoring and grouping.
`InstanceIdentifierKind`	`getInstanceIdentifierKind()` Returns the instance identifier kind.
`ResourceType[]`	`getResources()` Returns the resources to be accounted.
`static void`	`release(MonitoringGroupSettings instance)` Releases and clears the specified instance to the shared pool.
`void`	`setBasics(java.lang.String[] id, DebugState[] debugStates, GroupAccountingType gType, ResourceType[] resources, InstanceIdentifierKind instanceIdentifierKind)` Sets the basic values needed for monitoring.
`void`	`setMulti(BooleanValue distributeValues, BooleanValue considerContained)` Sets advanced values for multi monitoring groups.

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

- Field Detail
  - POOL
```
private static final ArrayList<MonitoringGroupSettings> POOL
```
    Stores instances of this class for reuse. As class loading usually happens not in parallel, not many instances will be stored here.
  - id
```
private java.lang.String[] id
```
    Contains arbitrary ids for monitoring and grouping.
    
    Since:
    
    1.00
  - debugStates
```
private DebugState[] debugStates
```
    Returns a combination of debug states for additional information to be emitted during monitoring.
    
    Since:
    
    1.00
  - gType
```
private GroupAccountingType gType
```
    Stores the group accounting to be applied. By default this value is set to GroupAccountingType.DEFAULT and, therefore, taken from the global configuration.
    
    Since:
    
    1.00
  - resources
```
private ResourceType[] resources
```
    Stores the resources to be accounted. By default, all resources defined in ResourceType are accounted.
    
    Since:
    
    1.00
  - instanceIdentifierKind
```
private InstanceIdentifierKind instanceIdentifierKind
```
    Stores the instance identifier kind.
    
    Since:
    
    1.20
  - distributeValues
```
private BooleanValue distributeValues
```
    Stores whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
    
    Since:
    
    1.00
  - considerContained
```
private BooleanValue considerContained
```
    Stores whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
    
    Since:
    
    1.00
- Constructor Detail
  - MonitoringGroupSettings
```
private MonitoringGroupSettings()
```
    Creates a new instance. Prevents creation from outside in order to enable pooling.
    
    Since:
    
    1.00
- Method Detail
  - create
```
public MonitoringGroupSettings create()
```
    Creates a further instance of this instances (intended as factory method to be executed on a prototypical instance).
    
    Returns:
    
    the created instance
    
    Since:
    
    1.00
  - clear
```
public void clear()
```
    Cleans the attributes of this instance.
    
    Since:
    
    1.00
  - setBasics
```
public void setBasics(java.lang.String[] id,
                      DebugState[] debugStates,
                      GroupAccountingType gType,
                      ResourceType[] resources,
                      InstanceIdentifierKind instanceIdentifierKind)
```
    Sets the basic values needed for monitoring.
    
    Parameters:
    
    id - the recorder ids
    
    debugStates - the intended debugging flags
    
    gType - the group accounting type
    
    resources - the accountable resources
    
    instanceIdentifierKind - the instance identifier kind
    
    Since:
    
    1.20
  - setMulti
```
public void setMulti(BooleanValue distributeValues,
                     BooleanValue considerContained)
```
    Sets advanced values for multi monitoring groups.
    
    Parameters:
    
    distributeValues - whether values should be distributed evenly
    
    considerContained - whether accountable resources of contained groups should be considered or whether the group is authoritive
    
    Since:
    
    1.00
  - getId
```
public java.lang.String[] getId()
```
    Contains arbitrary ids for monitoring and grouping.
    
    Returns:
    
    the ids
    
    Since:
    
    1.00
  - getDebugStates
```
public DebugState[] getDebugStates()
```
    Returns a combination of debug states for additional information to be emitted during monitoring.
    
    Returns:
    
    the debugging states
    
    Since:
    
    1.00
  - getAccountingType
```
public GroupAccountingType getAccountingType()
```
    Returns the group accounting to be applied. By default this value is set to GroupAccountingType.DEFAULT and, therefore, taken from the global configuration.
    
    Returns:
    
    the accounting type
    
    Since:
    
    1.00
  - getResources
```
public ResourceType[] getResources()
```
    Returns the resources to be accounted. By default, all resources defined in ResourceType are accounted.
    
    Returns:
    
    the accountable resources
    
    Since:
    
    1.00
  - getInstanceIdentifierKind
```
public InstanceIdentifierKind getInstanceIdentifierKind()
```
    Returns the instance identifier kind.
    
    Returns:
    
    the instance identifier kind
    
    Since:
    
    1.20
  - getDistributeValues
```
public BooleanValue getDistributeValues()
```
    Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
    
    Returns:
    
    true if values should be distributed, false if not
    
    Since:
    
    1.00
  - getConsiderContained
```
public BooleanValue getConsiderContained()
```
    Returns whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
    
    Returns:
    
    true if the contained groups values should be considered, false if the multi group is authoritative
    
    Since:
    
    1.00
  - getFromPool
```
public static final MonitoringGroupSettings getFromPool()
```
    Returns an instance from the shared pool. This explicit method is needed due to problems with javassist and Android.
    
    Returns:
    
    the instance from the pool. This instance has to be released by release(MonitoringGroupSettings).
    
    Since:
    
    SugiBib 1.20
  - release
```
public static final void release(MonitoringGroupSettings instance)
```
    Releases and clears the specified instance to the shared pool. This explicit method is needed due to problems with javassist and Android.
    
    Parameters:
    
    instance - the instance to be released (must not be null)

Class MonitoringGroupSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POOL

id

debugStates

gType

resources

instanceIdentifierKind

distributeValues

considerContained

Constructor Detail

MonitoringGroupSettings

Method Detail

create

clear

setBasics

setMulti

getId

getDebugStates

getAccountingType

getResources

getInstanceIdentifierKind

getDistributeValues

getConsiderContained

getFromPool

release