Module gg.xp.xivapi
Package gg.xp.xivapi.pagination

Enum Class ListCacheMode

java.lang.Object
java.lang.Enum<ListCacheMode>
gg.xp.xivapi.pagination.ListCacheMode
All Implemented Interfaces:
Serializable, Comparable<ListCacheMode>, Constable
public enum ListCacheMode extends Enum<ListCacheMode>
Controls how inner object deduplication works in the context of lists and searching. e.g. if two Items have the same ClassJobCategory, then instead of keeping two objects with identical contents in memory, both Items can simply point to the same ClassJobCategory instance. For single-object requests, the "scope" of deduplication is that single request. For lists/searches, the behavior can be configured, as if it is not expected that there will be very many duplicates, the caching may not be helpful.

  • Enum Constant Details

    • None

      public static final ListCacheMode None
      No caching at all.

    • PerItem

      public static final ListCacheMode PerItem
      Cache context per item - same as if the items were retrieved individually.

    • PerPage

      public static final ListCacheMode PerPage
      Cache context per page of items.

    • WholeQuery

      public static final ListCacheMode WholeQuery
      One cache context for the whole list/search.

  • Method Details

    • values

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

    • valueOf

      public static ListCacheMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null