Enum Metric

java.lang.Object
java.lang.Enum<Metric>
org.salespointframework.quantity.Metric
All Implemented Interfaces:
Serializable, Comparable<Metric>, Constable

public enum Metric
extends Enum<Metric>
All available metrics.
Author:
Oliver Gierke
  • Enum Constant Details

  • Method Details

    • values

      public static Metric[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static Metric valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • isCompatibleWith

      public boolean isCompatibleWith​(Metric metric)
      Returns whether the given Metric is
      Parameters:
      metric - must not be null.
      Returns:
    • from

      public static Metric from​(String abbreviation)
      Returns the Metric for the given abbreviation.
      Parameters:
      abbreviation - must not be null.
      Returns:
      will never be null.
      Throws:
      IllegalArgumentException - if no Metric can be found for the given abbreviation.
    • getAbbreviation

      public String getAbbreviation()
    • getAbbreviations

      public List<String> getAbbreviations()