Index (Jackson-annotations 2.5.0 API)
Date: 2015-01-01

B C D E F G H I J K M N O P R S T U V W _

## B

bindItem(ObjectIdGenerator.IdKey, Object) - Method in interface com.fasterxml.jackson.annotation.ObjectIdResolver
  Method called when a POJO is deserialized and has an Object Identifier.
bindItem(ObjectIdGenerator.IdKey, Object) - Method in class com.fasterxml.jackson.annotation.SimpleObjectIdResolver

## C

canUseFor(ObjectIdGenerator<?>) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Method called to check whether this generator instance can be used for Object Ids of specific generator type and scope; determination is based by passing a configured "blueprint" (prototype) instance; from which the actual instances are created (using `ObjectIdGenerator.newForSerialization(java.lang.Object)`).
canUseFor(ObjectIdGenerator<?>) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator
  Since UUIDs are always unique, let's fully ignore scope definition
canUseFor(ObjectIdResolver) - Method in interface com.fasterxml.jackson.annotation.ObjectIdResolver
  Method called to check whether this resolver instance can be used for Object Ids of specific resolver type; determination is based by passing a configured "blueprint" (prototype) instance; from which the actual instances are created (using `ObjectIdResolver.newForDeserialization(java.lang.Object)`).
canUseFor(ObjectIdResolver) - Method in class com.fasterxml.jackson.annotation.SimpleObjectIdResolver
com.fasterxml.jackson.annotation - package com.fasterxml.jackson.annotation
  Public core annotations, most of which are used to configure how Data Mapping/Binding works.
creatorEnabled() - Method in enum com.fasterxml.jackson.annotation.PropertyAccessor

## D

DEFAULT_LOCALE - Static variable in annotation type com.fasterxml.jackson.annotation.JsonFormat
  Value that indicates that default `Locale` (from deserialization or serialization context) should be used: annotation does not define value to use.
DEFAULT_TIMEZONE - Static variable in annotation type com.fasterxml.jackson.annotation.JsonFormat
  Value that indicates that default `TimeZone` (from deserialization or serialization context) should be used: annotation does not define value to use.

## E

equals(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey

## F

fieldEnabled() - Method in enum com.fasterxml.jackson.annotation.PropertyAccessor
forScope(Class<?>) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Factory method to create a blueprint instance for specified scope.
forScope(Class<?>) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
forScope(Class<?>) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator
  Can just return base instance since this is essentially scopeless

## G

generateId(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Method used for generating a new Object Identifier to serialize for given POJO.
generateId(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
generateId(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator
getDefaultPropertyName() - Method in enum com.fasterxml.jackson.annotation.JsonTypeInfo.Id
getLocale() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
getPattern() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
getScope() - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
getShape() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
getterEnabled() - Method in enum com.fasterxml.jackson.annotation.PropertyAccessor
getTimeZone() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value

## H

hashCode() - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey
hasLocale() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
hasPattern() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
hasShape() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
hasTimeZone() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value

## I

INDEX_UNKNOWN - Static variable in annotation type com.fasterxml.jackson.annotation.JsonProperty
  Marker value used to indicate that no index has been specified.
initialValue() - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
isGetterEnabled() - Method in enum com.fasterxml.jackson.annotation.PropertyAccessor
isNumeric() - Method in enum com.fasterxml.jackson.annotation.JsonFormat.Shape
isStructured() - Method in enum com.fasterxml.jackson.annotation.JsonFormat.Shape
isValidReferencePropertyName(String, Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Accessor that may be called (after verifying (via `ObjectIdGenerator.maySerializeAsObject()`) whether given name
isVisible(Member) - Method in enum com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility

## J

JacksonAnnotation - Annotation Type in com.fasterxml.jackson.annotation
  Meta-annotation (annotations used on other annotations) used for marking all annotations that are part of Jackson package.
JacksonAnnotationsInside - Annotation Type in com.fasterxml.jackson.annotation
  Meta-annotation (annotations used on other annotations) used for indicating that instead of using target annotation (annotation annotated with this annotation), Jackson should use meta-annotations it has.
JacksonInject - Annotation Type in com.fasterxml.jackson.annotation
  Jackson-specific annotation used for indicating that value of annotated property will be "injected", i.e.
JsonAnyGetter - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define a non-static, no-argument method or member field as something of a reverse of `JsonAnySetter` method; basically being used like a getter but such that contents of the returned Map (type must be `Map`) are serialized as if they were actual properties of the bean that contains method/field with this annotations.
JsonAnySetter - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define a non-static, two-argument method (first argument name of property, second value to set), to be used as a "fallback" handler for all otherwise unrecognized properties found from JSON content.
JsonAutoDetect - Annotation Type in com.fasterxml.jackson.annotation
  Class annotation that can be used to define which kinds of Methods are to be detected by auto-detection.
JsonAutoDetect.Visibility - Enum in com.fasterxml.jackson.annotation
  Enumeration for possible visibility thresholds (minimum visibility) that can be used to limit which methods (and fields) are auto-detected.
JsonBackReference - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used to indicate that associated property is part of two-way linkage between fields; and that its role is "child" (or "back") link.
JsonCreator - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define constructors and factory methods as one to use for instantiating new instances of the associated class.
JsonCreator.Mode - Enum in com.fasterxml.jackson.annotation
JsonFilter - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used to indicate which logical filter is to be used for filtering out properties of type (class) annotated; association made by this annotation declaring ids of filters, and `com.fasterxml.jackson.databind.ObjectMapper` (or objects it delegates to) providing matching filters by id.
JsonFormat - Annotation Type in com.fasterxml.jackson.annotation
  General-purpose annotation used for configuring details of how values of properties are to be serialized.
JsonFormat.Shape - Enum in com.fasterxml.jackson.annotation
  Value enumeration used for indicating preferred Shape; translates loosely to JSON types, with some extra values to indicate less precise choices (i.e.
JsonFormat.Value - Class in com.fasterxml.jackson.annotation
  Helper class used to contain information from a single `JsonFormat` annotation.
JsonFormat.Value() - Constructor for class com.fasterxml.jackson.annotation.JsonFormat.Value
JsonFormat.Value(JsonFormat) - Constructor for class com.fasterxml.jackson.annotation.JsonFormat.Value
JsonFormat.Value(String, JsonFormat.Shape, String, String) - Constructor for class com.fasterxml.jackson.annotation.JsonFormat.Value
JsonFormat.Value(String, JsonFormat.Shape, Locale, TimeZone) - Constructor for class com.fasterxml.jackson.annotation.JsonFormat.Value
JsonFormat.Value(String, JsonFormat.Shape, Locale, String, TimeZone) - Constructor for class com.fasterxml.jackson.annotation.JsonFormat.Value
JsonGetter - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define a non-static, no-argument value-returning (non-void) method to be used as a "getter" for a logical property.
JsonIdentityInfo - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used for indicating that values of annotated type or property should be serializing so that instances either contain additional object identifier (in addition actual object properties), or as a reference that consists of an object id that refers to a full serialization.
JsonIdentityReference - Annotation Type in com.fasterxml.jackson.annotation
  Optional annotation that can be used for customizing details of a reference to Objects for which "Object Identity" is enabled (see `JsonIdentityInfo`).
JsonIgnore - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that indicates that the annotated method or field is to be ignored by introspection-based serialization and deserialization functionality.
JsonIgnoreProperties - Annotation Type in com.fasterxml.jackson.annotation
  Annotation that can be used to either suppress serialization of properties (during serialization), or ignore processing of JSON properties read (during deserialization).
JsonIgnoreType - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that indicates that all properties of annotated type are to be ignored during serialization and deserialization.
JsonInclude - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized.
JsonInclude.Include - Enum in com.fasterxml.jackson.annotation
  Enumeration used with `JsonInclude` to define which properties of Java Beans are to be included in serialization.
JsonManagedReference - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used to indicate that annotated property is part of two-way linkage between fields; and that its role is "parent" (or "forward") link.
JsonProperty - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define a non-static method as a "setter" or "getter" for a logical property (depending on its signature), or non-static object field to be used (serialized, deserialized) as a logical property.
JsonPropertyDescription - Annotation Type in com.fasterxml.jackson.annotation
  Annotaion used to define a human readable description for a logical property.
JsonPropertyOrder - Annotation Type in com.fasterxml.jackson.annotation
  Annotation that can be used to define ordering (possibly partial) to use when serializing object properties.
JsonRawValue - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that indicates that the annotated method or field should be serialized by including literal String value of the property as is, without quoting of characters.
JsonRootName - Annotation Type in com.fasterxml.jackson.annotation
  Annotation similar to `XmlRootElement`, used to indicate name to use for root-level wrapping, if wrapping is enabled.
JsonSetter - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used to define a non-static, single-argument method to be used as a "setter" for a logical property as an alternative to recommended `JsonProperty` annotation (which was introduced in version 1.1).
JsonSubTypes - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used with `JsonTypeInfo` to indicate sub types of serializable polymorphic types, and to associate logical names used within JSON content (which is more portable than using physical Java class names).
JsonSubTypes.Type - Annotation Type in com.fasterxml.jackson.annotation
  Definition of a subtype, along with optional name.
JsonTypeId - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation that can be used on a property accessor (field, getter or setter, constructor parameter) to indicate that the property is to contain type id to use when including polymorphic type information.
JsonTypeInfo - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used for configuring details of if and how type information is used with JSON serialization and deserialization, to preserve information about actual class of Object instances.
JsonTypeInfo.As - Enum in com.fasterxml.jackson.annotation
  Definition of standard type inclusion mechanisms for type metadata.
JsonTypeInfo.Id - Enum in com.fasterxml.jackson.annotation
  Definition of different type identifiers that can be included in JSON during serialization, and used for deserialization.
JsonTypeInfo.None - Class in com.fasterxml.jackson.annotation
  Deprecated.
  Since 2.5, use `Void` instead.
JsonTypeInfo.None() - Constructor for class com.fasterxml.jackson.annotation.JsonTypeInfo.None
  Deprecated.
JsonTypeName - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used for binding logical name that the annotated class has.
JsonUnwrapped - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used to indicate that a property should be serialized "unwrapped"; that is, if it would be serialized as JSON Object, its properties are instead included as properties of its containing Object.
JsonValue - Annotation Type in com.fasterxml.jackson.annotation
  Marker annotation similar to `XmlValue` that indicates that results of the annotated "getter" method (which means signature must be that of getters; non-void return type, no args) is to be used as the single value to serialize for the instance.
JsonView - Annotation Type in com.fasterxml.jackson.annotation
  Annotation used for indicating view(s) that the property that is defined by method or field annotated is part of.

## K

key - Variable in class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey
  Object for which Object Id was generated: can NOT be null.
key(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Method for constructing key to use for ObjectId-to-POJO maps.
key(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
key(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator

## M

maySerializeAsObject() - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Accessor that needs to be overridden to return `true` if the Object Id may be serialized as JSON Object; used by, for example, JSOG handling.

## N

newForDeserialization(Object) - Method in interface com.fasterxml.jackson.annotation.ObjectIdResolver
  Factory method called to create a new instance to use for deserialization: needed since resolvers may have state (a pool of objects).
newForDeserialization(Object) - Method in class com.fasterxml.jackson.annotation.SimpleObjectIdResolver
newForSerialization(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerator
  Factory method called to create a new instance to use for serialization: needed since generators may have state (next id to produce).
newForSerialization(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
newForSerialization(Object) - Method in class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator
  Can just return base instance since this is essentially scopeless

## O

ObjectIdGenerator<T> - Class in com.fasterxml.jackson.annotation
  Definition of API used for constructing Object Identifiers (as annotated using `JsonIdentityInfo`).
ObjectIdGenerator() - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerator
ObjectIdGenerator.IdKey - Class in com.fasterxml.jackson.annotation
  Simple key class that can be used as a key for ObjectId-to-POJO mappings, when multiple ObjectId types and scopes are used.
ObjectIdGenerator.IdKey(Class<?>, Class<?>, Object) - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey
ObjectIdGenerators - Class in com.fasterxml.jackson.annotation
  Container class for standard `ObjectIdGenerator` implementations.
ObjectIdGenerators() - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators
ObjectIdGenerators.IntSequenceGenerator - Class in com.fasterxml.jackson.annotation
  Simple sequence-number based generator, which uses basic Java `int`s (starting with value 1) as Object Identifiers.
ObjectIdGenerators.IntSequenceGenerator() - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
ObjectIdGenerators.IntSequenceGenerator(Class<?>, int) - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator
ObjectIdGenerators.None - Class in com.fasterxml.jackson.annotation
  Abstract marker class used to allow explicitly specifying that no generator is used; which also implies that no Object Id is to be included or used.
ObjectIdGenerators.None() - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators.None
ObjectIdGenerators.PropertyGenerator - Class in com.fasterxml.jackson.annotation
  Abstract place-holder class which is used to denote case where Object Identifier to use comes from a POJO property (getter method or field).
ObjectIdGenerators.PropertyGenerator(Class<?>) - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators.PropertyGenerator
ObjectIdGenerators.UUIDGenerator - Class in com.fasterxml.jackson.annotation
  Implementation that just uses `UUID`s as reliably unique identifiers: downside is that resulting String is 36 characters long.
ObjectIdGenerators.UUIDGenerator() - Constructor for class com.fasterxml.jackson.annotation.ObjectIdGenerators.UUIDGenerator
ObjectIdResolver - Interface in com.fasterxml.jackson.annotation
  Definition of API used for resolving actual Java object from Object Identifiers (as annotated using `JsonIdentityInfo`).

## P

PropertyAccessor - Enum in com.fasterxml.jackson.annotation
  Enumeration used to define kinds of elements (called "property accessors") that annotations like `JsonAutoDetect` apply to.

## R

resolveId(ObjectIdGenerator.IdKey) - Method in interface com.fasterxml.jackson.annotation.ObjectIdResolver
  Method called when deserialization encounters the given Object Identifier and requires the POJO associated with it.
resolveId(ObjectIdGenerator.IdKey) - Method in class com.fasterxml.jackson.annotation.SimpleObjectIdResolver

## S

scope - Variable in class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey
  Scope of the Object Id (may be null, to denote global)
setterEnabled() - Method in enum com.fasterxml.jackson.annotation.PropertyAccessor
SimpleObjectIdResolver - Class in com.fasterxml.jackson.annotation
  Simple implementation of `ObjectIdResolver`
SimpleObjectIdResolver() - Constructor for class com.fasterxml.jackson.annotation.SimpleObjectIdResolver

## T

timeZoneAsString() - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
  Alternate access (compared to `JsonFormat.Value.getTimeZone()`) which is useful when caller just wants time zone id to convert, but not as JDK provided `TimeZone`
type - Variable in class com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey
  Type of `ObjectIdGenerator` used for generating Object Id

## U

USE_DEFAULT_NAME - Static variable in annotation type com.fasterxml.jackson.annotation.JsonProperty
  Special value that indicates that handlers should use the default name (derived from method or field name) for property.

## V

valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonCreator.Mode
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonFormat.Shape
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonInclude.Include
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonTypeInfo.As
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.JsonTypeInfo.Id
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.fasterxml.jackson.annotation.PropertyAccessor
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonCreator.Mode
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonFormat.Shape
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonInclude.Include
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonTypeInfo.As
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.JsonTypeInfo.Id
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.fasterxml.jackson.annotation.PropertyAccessor
  Returns an array containing the constants of this enum type, in the order they are declared.

## W

withLocale(Locale) - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
withPattern(String) - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
withShape(JsonFormat.Shape) - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value
withTimeZone(TimeZone) - Method in class com.fasterxml.jackson.annotation.JsonFormat.Value

## _

_items - Variable in class com.fasterxml.jackson.annotation.SimpleObjectIdResolver
_nextValue - Variable in class com.fasterxml.jackson.annotation.ObjectIdGenerators.IntSequenceGenerator

B C D E F G H I J K M N O P R S T U V W _

Copyright © 2014-2015 FasterXML. All Rights Reserved.