Module gg.xp.xivapi

Package gg.xp.xivapi.annotations

package gg.xp.xivapi.annotations
  • Annotation Interfaces
    Class
    Description
    EmptyStringNull
    Indicates that empty strings should be transformed to a null.
    NullIfZero
    Applicable to a sheet reference type (i.e.
    OmitZeroes
    Applicable to a list or array of a sheet reference type (e.g.
    XivApiAssetPath
     
    XivApiField
    Override the default field name to map to.
    XivApiLang
    Indicate that the field should be retrieved with the given language.
    XivApiMapKeys
    This annotation applies to a Map field.
    XivApiMetaField
    Similar to XivApiField, but indicates that the value comes from a top level field outside the "fields" object.
    XivApiRaw
    Indicates that the targeted method should be retrieved from xivapi using the @as(raw) decorator in the query.
    XivApiSheet
    Indicates that this object is a top-level sheet object.
    XivApiThis
    Indicates that instead of reading from a field, the current object itself should be used.
    XivApiTransientField
    Like XivApiField, but operates on the transient fields instead of the normal fields.