Enum BeaconMetaField

java.lang.Object
java.lang.Enum<BeaconMetaField>
com.thunken.beacon.BeaconMetaField
All Implemented Interfaces:
Serializable, Comparable<BeaconMetaField>, java.lang.constant.Constable, Predicate<String>

public enum BeaconMetaField
extends Enum<BeaconMetaField>
implements Predicate<String>
Enumerated type for BEACON meta fields.

Note: the current Javadoc for this project is incomplete. We rely on Lombok to generate boilerplate code, and Lombok does not plug into Javadoc. Generated methods and constructors are not included, and the Javadoc for other methods and constructors may be incomplete. See delombok and beacon#1 for more information.

See Also:
BeaconMetaField.Type, BeaconMetaFields, https://gbv.github.io/beaconspec/beacon.html#meta-fields
  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static BeaconMetaField[] 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 BeaconMetaField 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
    • getDefaultValue

      public String getDefaultValue()
    • getDefaultValues

      @Deprecated public Set<String> getDefaultValues()
      Deprecated.
      Returns an immutable singleton set containing the default value for this meta field.
      Returns:
      an immutable singleton set containing the default value for this meta field.
    • getType

      public BeaconMetaField.Type getType()
    • getValueType

      public BeaconMetaField.ValueType getValueType()
    • isRepeatable

      @Deprecated public boolean isRepeatable()
      Deprecated.
      Meta fields are not repeatable anymore, so this method always returns false.
      Returns true if this meta field is repeatable.
      Returns:
      false
    • test

      public boolean test​(String value)
      Specified by:
      test in interface Predicate<String>