Package de.oliver.fancyanalytics.api

Class FancyAnalyticsAPI

java.lang.Object
de.oliver.fancyanalytics.api.FancyAnalyticsAPI
public class FancyAnalyticsAPI extends Object

  • Field Details

    • LOGGER

      public static final Logger LOGGER

  • Constructor Details

  • Method Details

    • initialize

      public void initialize()

    • reportError

      public void reportError(Throwable throwable)
      Reports an error by sending it to the configured analytics server.
      Parameters:
      throwable - The Throwable object representing the error to be reported.

    • sendEvent

      public void sendEvent(de.oliver.fancyanalytics.sdk.events.Event event)
      Sends an event to the analytics server.
      Parameters:
      event - The Event object containing the name and properties of the event to be sent.

    • registerMinecraftPluginMetrics

      public void registerMinecraftPluginMetrics(org.bukkit.plugin.Plugin plugin)
      Registers the default metrics related to the provided plugin.
      Parameters:
      plugin - the Plugin instance for which to register the default metrics

    • registerNumberMetric

      public void registerNumberMetric(MetricSupplier<Double> metric)
      Registers a numerical metric using the provided MetricSupplier. The metric will be stored and managed by the FancyAnalyticsAPI instance.
      Parameters:
      metric - the MetricSupplier containing the name and value supplier of the numeric metric to be registered
      Throws:
      IllegalArgumentException - if a metric with the same name already exists

    • registerNumberArrayMetric

      public void registerNumberArrayMetric(MetricSupplier<Double[]> metric)
      Registers a numerical array metric using the provided MetricSupplier. The metric will be stored and managed by the FancyAnalyticsAPI instance.
      Parameters:
      metric - the MetricSupplier containing the name and value supplier of the numeric array metric to be registered
      Throws:
      IllegalArgumentException - if a metric with the same name already exists

    • registerStringMetric

      public void registerStringMetric(MetricSupplier<String> metric)
      Registers a string metric using the provided MetricSupplier. The metric will be stored and managed by the FancyAnalyticsAPI instance.
      Parameters:
      metric - the MetricSupplier containing the name and value supplier of the string metric to be registered
      Throws:
      IllegalArgumentException - if a metric with the same name already exists

    • registerStringArrayMetric

      public void registerStringArrayMetric(MetricSupplier<String[]> metric)
      Registers a string array metric using the provided MetricSupplier. The metric will be stored and managed by the FancyAnalyticsAPI instance.
      Parameters:
      metric - the MetricSupplier containing the name and value supplier of the string array metric to be registered
      Throws:
      IllegalArgumentException - if a metric with the same name already exists

    • getExceptionHandler

      public GlobalExceptionHandler getExceptionHandler()
      Gets the GlobalExceptionHandler instance associated with this FancyAnalyticsAPI.
      Returns:
      the current instance of GlobalExceptionHandler.

    • getConfig

      public Configuration getConfig()