package io.vertx.micrometer;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;

A match for a value.
Author:
Julien Viet/**
 * A match for a value.
 *
 * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
 */
@DataObject
public class Match {
  
The default value : MatchType.EQUALS /**
   * The default value : {@link MatchType#EQUALS}
   */
  public static final MatchType DEFAULT_TYPE = MatchType.EQUALS;

  private MetricsDomain domain;
  private String label;
  private String value;
  private MatchType type;
  private String alias;

  
Default constructor
/**
   * Default constructor
   */
  public Match() {
    type = DEFAULT_TYPE;
  }

  
Copy constructor
Params:
other – The other Match to copy when creating this/**
   * Copy constructor
   *
   * @param other The other {@link Match} to copy when creating this
   */
  public Match(Match other) {
    domain = other.domain;
    label = other.label;
    value = other.value;
    type = other.type;
  }

  
Create an instance from a JsonObject 
Params:
json – the JsonObject to create it from/**
   * Create an instance from a {@link JsonObject}
   *
   * @param json the JsonObject to create it from
   */
  public Match(JsonObject json) {
    if (json.containsKey("domain")) {
      domain = MetricsDomain.valueOf(json.getString("domain"));
    }
    label = json.getString("label");
    value = json.getString("value");
    type = MatchType.valueOf(json.getString("type", DEFAULT_TYPE.name()));
    alias = json.getString("alias");
  }

  
Returns:
the label domain/**
   * @return the label domain
   */
  public MetricsDomain getDomain() {
    return domain;
  }

  
Set the label domain, restricting this rule to a single domain.
Params:
domain – the label domain
Returns:
a reference to this, so the API can be used fluently/**
   * Set the label domain, restricting this rule to a single domain.
   *
   * @param domain the label domain
   * @return a reference to this, so the API can be used fluently
   */
  public Match setDomain(MetricsDomain domain) {
    this.domain = domain;
    return this;
  }

  
Returns:
the label name/**
   * @return the label name
   */
  public String getLabel() {
    return label;
  }

  
Set the label name. The match will apply to the values related to this key.
Params:
label – the label name
Returns:
a reference to this, so the API can be used fluently/**
   * Set the label name. The match will apply to the values related to this key.
   *
   * @param label the label name
   * @return a reference to this, so the API can be used fluently
   */
  public Match setLabel(String label) {
    this.label = label;
    return this;
  }

  
Returns:
the matched value/**
   * @return the matched value
   */
  public String getValue() {
    return value;
  }

  
Set the matched value.
Params:
value – the value to match
Returns:
a reference to this, so the API can be used fluently/**
   * Set the matched value.
   *
   * @param value the value to match
   * @return a reference to this, so the API can be used fluently
   */
  public Match setValue(String value) {
    this.value = value;
    return this;
  }

  
Returns:
the matcher type/**
   * @return the matcher type
   */
  public MatchType getType() {
    return type;
  }

  
Set the type of matching to apply.
Params:
type – the matcher type
Returns:
a reference to this, so the API can be used fluently/**
   * Set the type of matching to apply.
   *
   * @param type the matcher type
   * @return a reference to this, so the API can be used fluently
   */
  public Match setType(MatchType type) {
    this.type = type;
    return this;
  }

  
Returns:
the matcher alias/**
   * @return the matcher alias
   */
  public String getAlias() {
    return alias;
  }

  
Set an alias that would replace the label value when it matches.
Params:
alias – the matcher alias
Returns:
a reference to this, so the API can be used fluently/**
   * Set an alias that would replace the label value when it matches.
   *
   * @param alias the matcher alias
   * @return a reference to this, so the API can be used fluently
   */
  public Match setAlias(String alias) {
    this.alias = alias;
    return this;
  }
}