Metadata (Eclipse MicroProfile 3.3)

All Known Implementing Classes:

DefaultMetadata
```
public interface Metadata
```
Bean holding the metadata of one single metric.
The metadata contains:
- Name: (Required) The name of the metric.
- Display name: (Optional) The display (friendly) name of the metric. By default, it is set to the Name.
- Description: (Optional) A human readable description of the metric.
- Type: (Required) The type of the metric. See MetricType.
- Unit: (Optional) The unit of the metric. The unit may be any unit specified as a String or one specified in MetricUnits.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static MetadataBuilder`	`builder()`	Returns a new builder
`static MetadataBuilder`	`builder(Metadata metadata)`	Returns a new builder with the `Metadata` information
`java.util.Optional<java.lang.String>`	`getDescription()`	Returns the description of the metric.
`java.lang.String`	`getDisplayName()`	Returns the display name if set, otherwise this method returns the metric name.
`java.lang.String`	`getName()`	Returns the metric name.
`java.lang.String`	`getType()`	Returns the String representation of the `MetricType`.
`MetricType`	`getTypeRaw()`	Returns the `MetricType` of the metric
`java.util.Optional<java.lang.String>`	`getUnit()`
`boolean`	`isReusable()`

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the metric name.
    
    Returns:
    
    the metric name.
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Returns the display name if set, otherwise this method returns the metric name.
    
    Returns:
    
    the display name
  - getDescription
```
java.util.Optional<java.lang.String> getDescription()
```
    Returns the description of the metric.
    
    Returns:
    
    the description
  - getType
```
java.lang.String getType()
```
    Returns the String representation of the MetricType.
    
    Returns:
    
    the MetricType as a String
    
    See Also:
    
    MetricType
  - getTypeRaw
```
MetricType getTypeRaw()
```
    Returns the MetricType of the metric
    
    Returns:
    
    the MetricType
  - getUnit
```
java.util.Optional<java.lang.String> getUnit()
```
  - isReusable
```
boolean isReusable()
```
  - builder
```
static MetadataBuilder builder()
```
    Returns a new builder
    
    Returns:
    
    a new MetadataBuilder instance
  - builder
```
static MetadataBuilder builder(Metadata metadata)
```
    Returns a new builder with the Metadata information
    
    Parameters:
    
    metadata - the metadata
    
    Returns:
    
    a new MetadataBuilder instance with the Metadata values
    
    Throws:
    
    java.lang.NullPointerException - when metadata is null