Module tools.jackson.jakarta.rs.base

Package tools.jackson.jakarta.rs.cfg

Enum Class JakartaRSFeature

java.lang.Object

java.lang.Enum<JakartaRSFeature>

tools.jackson.jakarta.rs.cfg.JakartaRSFeature

All Implemented Interfaces:

Serializable, Comparable<JakartaRSFeature>, Constable, tools.jackson.databind.cfg.ConfigFeature

public enum JakartaRSFeature
extends Enum<JakartaRSFeature>
implements tools.jackson.databind.cfg.ConfigFeature

Enumeration that defines simple on/off features that can be used on all Jackson Jakarta-RS providers, regardless of underlying data format.

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
ADD_NO_SNIFF_HEADER	Feature that can be enabled to make provider automatically add "nosniff" (see this entry for details
ALLOW_EMPTY_INPUT	Feature to define whether empty input is considered legal or not.
CACHE_ENDPOINT_READERS	Feature that determines whether provider will cache endpoint definitions for reading or not (including caching of actual ObjectReader to use).
CACHE_ENDPOINT_WRITERS	Feature that determines whether provider will cache endpoint definitions for writing or not (including caching of actual ObjectWriter to use).
DYNAMIC_OBJECT_MAPPER_LOOKUP	Feature that may be enabled to force dynamic lookup of ObjectMapper via Jakarta-RS Provider interface, regardless of whether MapperConfigurator has explicitly configured mapper or not; if disabled, static configuration will take precedence.
READ_FULL_STREAM	For HTTP keep-alive or multipart content to work correctly, Jackson must read the entire HTTP input stream up until reading EOF (-1).

Method Summary

Modifier and Type	Method	Description
static int	collectDefaults()
boolean	enabledByDefault()
boolean	enabledIn(int flags)
int	getMask()
static JakartaRSFeature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JakartaRSFeature[]	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

ALLOW_EMPTY_INPUT

public static final JakartaRSFeature ALLOW_EMPTY_INPUT

Feature to define whether empty input is considered legal or not. If set to true, empty content is allowed and will be read as Java 'null': if false, an IOException will be thrown.

NOTE: in case of Jakarta-RS 2.0, specific exception will be jakarta.ws.rs.core.NoContentException,

READ_FULL_STREAM

public static final JakartaRSFeature READ_FULL_STREAM

For HTTP keep-alive or multipart content to work correctly, Jackson must read the entire HTTP input stream up until reading EOF (-1). Issue #108 If set to true, always consume all input content. This has a side-effect of failing on trailing content.

Feature is enabled by default. Note that this means that behavior in earlier versions (2.14 and before) differs from 2.15 and later.

Since:

2.15

ADD_NO_SNIFF_HEADER

public static final JakartaRSFeature ADD_NO_SNIFF_HEADER

Feature that can be enabled to make provider automatically add "nosniff" (see this entry for details

Feature is disabled by default.

DYNAMIC_OBJECT_MAPPER_LOOKUP

public static final JakartaRSFeature DYNAMIC_OBJECT_MAPPER_LOOKUP

Feature that may be enabled to force dynamic lookup of ObjectMapper via Jakarta-RS Provider interface, regardless of whether MapperConfigurator has explicitly configured mapper or not; if disabled, static configuration will take precedence. Note that if this feature is enabled, it typically makes sense to also disable CACHE_ENDPOINT_READERS and CACHE_ENDPOINT_WRITERS since caching would prevent lookups.

Feature is disabled by default.

CACHE_ENDPOINT_READERS

public static final JakartaRSFeature CACHE_ENDPOINT_READERS

Feature that determines whether provider will cache endpoint definitions for reading or not (including caching of actual ObjectReader to use). Feature may be disabled if reconfiguration or alternate instance of ObjectMapper is needed.

Note that disabling of the feature may add significant amount of overhead for processing.

Feature is enabled by default.

CACHE_ENDPOINT_WRITERS

public static final JakartaRSFeature CACHE_ENDPOINT_WRITERS

Feature that determines whether provider will cache endpoint definitions for writing or not (including caching of actual ObjectWriter to use). Feature may be disabled if reconfiguration or alternate instance of ObjectMapper is needed.

Note that disabling of the feature may add significant amount of overhead for processing.

Feature is enabled by default.

Method Details

values

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

collectDefaults

public static int collectDefaults()

enabledByDefault

public boolean enabledByDefault()

Specified by:

enabledByDefault in interface tools.jackson.databind.cfg.ConfigFeature

getMask

public int getMask()

Specified by:

getMask in interface tools.jackson.databind.cfg.ConfigFeature

enabledIn

public boolean enabledIn(int flags)

Specified by:

enabledIn in interface tools.jackson.databind.cfg.ConfigFeature