Package org.eclipse.microprofile.metrics

Class MetadataBuilder

java.lang.Object
org.eclipse.microprofile.metrics.MetadataBuilder
public class MetadataBuilder extends Object
The Metadata builder. This builder has a default value: type as MetricType.INVALID unit as MetricUnits.NONE reusable as Boolean.FALSE

  • Constructor Details

    • MetadataBuilder

      public MetadataBuilder()

  • Method Details

    • withName

      public MetadataBuilder withName(String name)
      Sets the name. Does not accept null.
      Parameters:
      name - the name
      Returns:
      the builder instance
      Throws:
      NullPointerException - when name is null

    • withDisplayName

      public MetadataBuilder withDisplayName(String displayName)
      Sets the displayName. Does not accept null.
      Parameters:
      displayName - the displayName
      Returns:
      the builder instance
      Throws:
      NullPointerException - when displayName is null

    • withOptionalDisplayName

      public MetadataBuilder withOptionalDisplayName(String displayName)
      Sets the displayName. Does accept null.
      Parameters:
      displayName - the displayName
      Returns:
      the builder instance

    • withDescription

      public MetadataBuilder withDescription(String description)
      Sets the description. Does not accept null.
      Parameters:
      description - the name
      Returns:
      the builder instance
      Throws:
      NullPointerException - when description is null

    • withOptionalDescription

      public MetadataBuilder withOptionalDescription(String description)
      Sets the description. Does accept null.
      Parameters:
      description - the name
      Returns:
      the builder instance

    • withType

      public MetadataBuilder withType(MetricType type)
      Sets the type. Does not accept null.
      Parameters:
      type - the type
      Returns:
      the builder instance
      Throws:
      NullPointerException - when type is null

    • withOptionalType

      public MetadataBuilder withOptionalType(MetricType type)
      Sets the type. Does accept null.
      Parameters:
      type - the type
      Returns:
      the builder instance

    • withUnit

      public MetadataBuilder withUnit(String unit)
      Sets the unit. Does not accept null.
      Parameters:
      unit - the unit
      Returns:
      the builder instance
      Throws:
      NullPointerException - when unit is null

    • withOptionalUnit

      public MetadataBuilder withOptionalUnit(String unit)
      Sets the unit. Does accept null.
      Parameters:
      unit - the unit
      Returns:
      the builder instance

    • reusable

      public MetadataBuilder reusable()
      Sets the reusability flag to Boolean.TRUE
      Returns:
      the builder instance

    • reusable

      public MetadataBuilder reusable(boolean value)
      Sets the reusability flag to the desired boolean value
      Parameters:
      value - the value of the reusability flag
      Returns:
      the builder instance

    • notReusable

      public MetadataBuilder notReusable()
      Sets the reusability flag to Boolean.FALSE
      Returns:
      the builder instance

    • build

      public Metadata build()
      Returns:
      An object implementing Metadata from the provided properties
      Throws:
      IllegalStateException - when either name is null