All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.fasterxml.jackson.annotation.JsonIgnore Maven / Gradle / Ivy

Go to download

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2
Show newest version
package com.fasterxml.jackson.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marker annotation that indicates that the logical property that
 * the accessor (field, getter/setter method or Creator parameter
 * [of {@link JsonCreator}-annotated constructor or factory method])
 * is to be ignored by introspection-based
 * serialization and deserialization functionality.
 *

* Annotation only needs to be added to one of the accessors (often * getter method, but may be setter, field or creator parameter), * if the complete removal of the property is desired. * However: if only particular accessor is to be ignored (for example, * when ignoring one of potentially conflicting setter methods), * this can be done by annotating other not-to-be-ignored accessors * with {@link JsonProperty} (or its equivalents). This is considered * so-called "split property" case and allows definitions of * "read-only" (read from input into POJO) and "write-only" (write * in output but ignore on output) *
* NOTE! As Jackson 2.6, there is a new and improved way to define * `read-only` and `write-only` properties, using * {@link JsonProperty#access()} annotation: this is recommended over * use of separate JsonIgnore and {@link JsonProperty} * annotations. *

* For example, a "getter" method that would otherwise denote * a property (like, say, "getValue" to suggest property "value") * to serialize, would be ignored and no such property would * be output unless another annotation defines alternative method to use. *

* When ignoring the whole property, the default behavior if encountering * such property in input is to ignore it without exception; but if there * is a {@link JsonAnySetter} it will be called instead. Either way, * no exception will be thrown. *

* Annotation is usually used just a like a marker annotation, that * is, without explicitly defining 'value' argument (which defaults * to true): but argument can be explicitly defined. * This can be done to override an existing `JsonIgnore` by explicitly * defining one with 'false' argument: either in a subclass, or by * using "mix-in annotations". */ @Target({ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @JacksonAnnotation public @interface JsonIgnore { /** * Optional argument that defines whether this annotation is active * or not. The only use for value 'false' if for overriding purposes * (which is not needed often); most likely it is needed for use * with "mix-in annotations" (aka "annotation overrides"). * For most cases, however, default value of "true" is just fine * and should be omitted. * * @return True if annotation is enabled (normal case); false if it is to * be ignored (only useful for mix-in annotations to "mask" annotation) */ boolean value() default true; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy