Package ca.uhn.fhir.rest.param

Enum ParamPrefixEnum

java.lang.Object
java.lang.Enum<ParamPrefixEnum>
ca.uhn.fhir.rest.param.ParamPrefixEnum
All Implemented Interfaces:
Serializable, Comparable<ParamPrefixEnum>, java.lang.constant.Constable
public enum ParamPrefixEnum extends Enum<ParamPrefixEnum>
Comparator/qualifier for values used in REST params, such as DateParam, NumberParam, and QuantityParam
Since:
1.5

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    APPROXIMATE
    Code Value: eq The actual value is equal to the given value
    ENDS_BEFORE
    Code Value: eb The range of the search value does overlap not with the range of the target value, and the range above the search value contains the range of the target value
    EQUAL
    Code Value: eq The actual value is equal to the given value
    GREATERTHAN
    Code Value: gt The actual value is greater than the given value.
    GREATERTHAN_OR_EQUALS
    Code Value: ge The actual value is greater than or equal to the given value.
    LESSTHAN
    Code Value: lt The actual value is less than the given value.
    LESSTHAN_OR_EQUALS
    Code Value: le The actual value is less than or equal to the given value.
    NOT_EQUAL
    Code Value: ne The actual value is not equal to the given value
    STARTS_AFTER
    Code Value: sa The range of the search value does not overlap with the range of the target value, and the range below the search value contains the range of the target value

  • Method Summary

    Modifier and Type
    Method
    Description
    static ParamPrefixEnum
    forValue​(String theValue)
    Returns the prefix associated with a given DSTU2+ value (e.g.
    String
    getValue()
    Returns the value, e.g.
    static ParamPrefixEnum
    valueOf​(String name)
    Returns the enum constant of this type with the specified name.
    static ParamPrefixEnum[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • APPROXIMATE

      public static final ParamPrefixEnum APPROXIMATE
      Code Value: eq The actual value is equal to the given value

    • ENDS_BEFORE

      public static final ParamPrefixEnum ENDS_BEFORE
      Code Value: eb The range of the search value does overlap not with the range of the target value, and the range above the search value contains the range of the target value

    • EQUAL

      public static final ParamPrefixEnum EQUAL
      Code Value: eq The actual value is equal to the given value

    • GREATERTHAN

      public static final ParamPrefixEnum GREATERTHAN
      Code Value: gt The actual value is greater than the given value.

    • GREATERTHAN_OR_EQUALS

      public static final ParamPrefixEnum GREATERTHAN_OR_EQUALS
      Code Value: ge The actual value is greater than or equal to the given value.

    • LESSTHAN

      public static final ParamPrefixEnum LESSTHAN
      Code Value: lt The actual value is less than the given value.

    • LESSTHAN_OR_EQUALS

      public static final ParamPrefixEnum LESSTHAN_OR_EQUALS
      Code Value: le The actual value is less than or equal to the given value.

    • NOT_EQUAL

      public static final ParamPrefixEnum NOT_EQUAL
      Code Value: ne The actual value is not equal to the given value

    • STARTS_AFTER

      public static final ParamPrefixEnum STARTS_AFTER
      Code Value: sa The range of the search value does not overlap with the range of the target value, and the range below the search value contains the range of the target value

  • Method Details

    • values

      public static ParamPrefixEnum[] 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 ParamPrefixEnum 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

    • getValue

      public String getValue()
      Returns the value, e.g. lt or eq

    • forValue

      public static ParamPrefixEnum forValue​(String theValue)
      Returns the prefix associated with a given DSTU2+ value (e.g. lt or eq)
      Parameters:
      theValue - e.g. < or ~
      Returns:
      The prefix, or null if no prefix matches the value