Module com.fasterxml.jackson.annotation
Package com.fasterxml.jackson.annotation

Enum Class PropertyAccessor

java.lang.Object
java.lang.Enum<PropertyAccessor>
com.fasterxml.jackson.annotation.PropertyAccessor
All Implemented Interfaces:
Serializable, Comparable<PropertyAccessor>, Constable
public enum PropertyAccessor extends Enum<PropertyAccessor>
Enumeration used to define kinds of elements (called "property accessors") that annotations like JsonAutoDetect apply to.

In addition to method types (GETTER/IS_GETTER, SETTER, CREATOR, SCALAR_CONSTRUCTOR) and the field type (FIELD), 2 pseudo-types are defined for convenience: ALWAYS and NONE. These can be used to indicate, all or none of available method types (respectively), for use by annotations that takes JsonMethod argument.

  • 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
    ALL
    This pseudo-type indicates that all accessors are affected.
    CREATOR
    Creators are constructors and (static) factory methods used to construct POJO instances for deserialization, not including single-scalar-argument constructors (for which SCALAR_CONSTRUCTOR is used).
    FIELD
    Field refers to fields of regular Java objects.
    GETTER
    Getters are methods used to get a POJO field value for serialization, or, under certain conditions also for de-serialization.
    IS_GETTER
    "Is getters" are getter-like methods that are named "isXxx" (instead of "getXxx" for getters) and return boolean value (either primitive, or Boolean).
    NONE
    This pseudo-type indicates that none of accessors if affected.
    SCALAR_CONSTRUCTOR
    Scalar constructors are special case creators: constructors that take just one scalar argument of one types int, long, boolean, double or String.
    SETTER
    Setters are methods used to set a POJO value for deserialization.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    creatorEnabled()
     
    boolean
    fieldEnabled()
     
    boolean
    getterEnabled()
     
    boolean
    isGetterEnabled()
     
    boolean
    scalarConstructorEnabled()
     
    boolean
    setterEnabled()
     
    static PropertyAccessor
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PropertyAccessor[]
    values()
    Returns an array containing the constants of this enum class, 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

    • GETTER

      public static final PropertyAccessor GETTER
      Getters are methods used to get a POJO field value for serialization, or, under certain conditions also for de-serialization. Latter can be used for effectively setting Collection or Map values in absence of setters, if returned value is not a copy but actual value of the logical property.

      Since version 1.3, this does NOT include "is getters" (methods that return boolean and named 'isXxx' for property 'xxx'); instead, IS_GETTER is used.

    • SETTER

      public static final PropertyAccessor SETTER
      Setters are methods used to set a POJO value for deserialization.

    • FIELD

      public static final PropertyAccessor FIELD
      Field refers to fields of regular Java objects. Although they are not really methods, addition of optional field-discovery in version 1.1 meant that there was need to enable/disable their auto-detection, and this is the place to add it in.

    • IS_GETTER

      public static final PropertyAccessor IS_GETTER
      "Is getters" are getter-like methods that are named "isXxx" (instead of "getXxx" for getters) and return boolean value (either primitive, or Boolean).

    • CREATOR

      public static final PropertyAccessor CREATOR
      Creators are constructors and (static) factory methods used to construct POJO instances for deserialization, not including single-scalar-argument constructors (for which SCALAR_CONSTRUCTOR is used).

    • SCALAR_CONSTRUCTOR

      public static final PropertyAccessor SCALAR_CONSTRUCTOR
      Scalar constructors are special case creators: constructors that take just one scalar argument of one types int, long, boolean, double or String.
      Since:
      3.0

    • NONE

      public static final PropertyAccessor NONE
      This pseudo-type indicates that none of accessors if affected.

    • ALL

      public static final PropertyAccessor ALL
      This pseudo-type indicates that all accessors are affected.

  • Method Details

    • values

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

    • creatorEnabled

      public boolean creatorEnabled()

    • scalarConstructorEnabled

      public boolean scalarConstructorEnabled()

    • getterEnabled

      public boolean getterEnabled()

    • isGetterEnabled

      public boolean isGetterEnabled()

    • setterEnabled

      public boolean setterEnabled()

    • fieldEnabled

      public boolean fieldEnabled()