io.dropwizard.metrics.BaseFormattedReporterFactory Maven / Gradle / Ivy

Go to download

package io.dropwizard.metrics;

import com.fasterxml.jackson.annotation.JsonProperty;

import javax.validation.constraints.NotNull;
import java.util.Locale;

/**
 * A base {@link ReporterFactory} for configuring metric reporters with formatting options.
 * 
 * Configures formatting options common to some {@link com.codahale.metrics.ScheduledReporter}s.
 * 

 * Configuration Parameters:
 * 
 *     
 *         
 *         
 *         
 *     
 *     
 *         
 *         
 *         
 *     
 *     
 *         
 *     
 * Name Default Description
locale System default {@link Locale}. The {@link Locale} for formatting numbers, dates and times.
See {@link BaseReporterFactory} for more options.
 */
public abstract class BaseFormattedReporterFactory extends BaseReporterFactory {
    @NotNull
    private Locale locale = Locale.getDefault();

    @JsonProperty
    public Locale getLocale() {
        return locale;
    }

    @JsonProperty
    public void setLocale(Locale locale) {
        this.locale = locale;
    }
}

Name	Default	Description
locale	System default {@link Locale}.	The {@link Locale} for formatting numbers, dates and times.
See {@link BaseReporterFactory} for more options.