UsageSample (Rhino Extensions 3.2 API)

```
@Retention(RUNTIME)
@Target(METHOD)
@Documented
public @interface UsageSample
```
Annotation that can be used to provide addition information about a usage sample statistic to the SLEE.

Since:

Rhino 2.4.0

Required Element Summary

Required Elements
Modifier and Type Required Element Description

SampleUnits displayUnits
How units should be presented.

SampleUnits sourceUnits
The type of units being sampled.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`boolean`	`aggregate`	Flag indicating whether or not updates to this sample will aggregate in the parent usage parameter set.
`String`	`description`	An arbitrary description about what is being sampled.
`String`	`shortName`	A shortened version of the sample name.
`String`	`unitLabel`	A label for the sample’s unit type.

- Element Detail
  - sourceUnits
```
SampleUnits sourceUnits
```
    The type of units being sampled.
    
    Since:
    
    Rhino 2.4.0
- - displayUnits
```
SampleUnits displayUnits
```
    How units should be presented.
    
    Since:
    
    Rhino 2.4.0
- - description
```
String description
```
    An arbitrary description about what is being sampled.
    
    Since:
    
    Rhino 2.4.0
    
    Default:
    
    ""
- - aggregate
```
boolean aggregate
```
    Flag indicating whether or not updates to this sample will aggregate in the parent usage parameter set. Aggregation can only occur if the parent usage parameter set is the same type as the child, or if the child’s parameter set type extends the parent’s parameter set type and the parent type defines the same sample.
    
    Since:
    
    Rhino 2.4.0
    
    Default:
    
    true
- - shortName
```
String shortName
```
    A shortened version of the sample name.
    
    Since:
    
    Rhino 2.4.0
    
    Default:
    
    ""
- - unitLabel
```
String unitLabel
```
    A label for the sample’s unit type.
    
    Since:
    
    Rhino 2.4.0
    
    Default:
    
    ""