Enum PointInTimeType

  • All Implemented Interfaces:
    Serializable, Comparable<PointInTimeType>

    public enum PointInTimeType
    extends Enum<PointInTimeType>
    Specifies the point in time for the returned data. This option controls whether fresh or cached data will be returned or whether future data projection will be returned. MidPoint usually deals with fresh data that describe situation at the current point in time. But the client code may want to get data from the cache that may be possibly stale. Or the client code may want a projection about the future state of the data (e.g. taking running asynchronous operation into consideration).
    • Enum Constant Detail

      • CACHED

        public static final PointInTimeType CACHED
        Return cached data (if available). Avoid fetching the data from external system.
      • CURRENT

        public static final PointInTimeType CURRENT
        Return current data. Fetch from external system if needed. The "current" has to be understood in Einsteinean sense. The returned data are as fresh as possible - but that still may be hours or days old for some resources. This is usually the default.
      • FUTURE

        public static final PointInTimeType FUTURE
        Returns current data and applies all the available projections about future state of the data. E.g. applies projected state of pending asynchronous operations.
    • Method Detail

      • values

        public static PointInTimeType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PointInTimeType c : PointInTimeType.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PointInTimeType 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.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null