diff --git a/docs/javadoc/2.13/allclasses-frame.html b/docs/javadoc/2.13/allclasses-frame.html new file mode 100644 index 00000000..887f5daf --- /dev/null +++ b/docs/javadoc/2.13/allclasses-frame.html @@ -0,0 +1,68 @@ + + + +
+ + +public class Jaxrs2TypesModule
+extends com.fasterxml.jackson.databind.module.SimpleModule
+Link
: serialized using "link header" representation
+ com.fasterxml.jackson.databind.Module.SetupContext
_abstractTypes, _deserializerModifier, _deserializers, _hasExplicitName, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version
Constructor and Description | +
---|
Jaxrs2TypesModule() |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+equals(Object o) |
+
String |
+getModuleName() |
+
int |
+hashCode() |
+
_checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getTypeId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setupModule, setValueInstantiators, version
getDependencies
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/LinkDeserializer.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/LinkDeserializer.html new file mode 100644 index 00000000..0af94c7b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/LinkDeserializer.html @@ -0,0 +1,358 @@ + + + + + + +public class LinkDeserializer
+extends com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer<javax.ws.rs.core.Link>
+com.fasterxml.jackson.databind.JsonDeserializer.None
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
Constructor and Description | +
---|
LinkDeserializer() |
+
Modifier and Type | +Method and Description | +
---|---|
javax.ws.rs.core.Link |
+deserialize(com.fasterxml.jackson.core.JsonParser p,
+ com.fasterxml.jackson.databind.DeserializationContext ctxt) |
+
deserialize, deserializeWithType, getEmptyAccessPattern, getNullAccessPattern, logicalType, supportsUpdate
_byteOverflow, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkTextualNull, _coerceBooleanFromInt, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _failDoubleToIntCoercion, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isEmptyOrTextualNull, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueInstantiator, getValueType, getValueType, handledType, handleMissingEndArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer
deserializeWithType, findBackReference, getAbsentValue, getDelegatee, getEmptyValue, getEmptyValue, getKnownPropertyNames, getNullValue, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer
public javax.ws.rs.core.Link deserialize(com.fasterxml.jackson.core.JsonParser p, + com.fasterxml.jackson.databind.DeserializationContext ctxt) + throws IOException+
deserialize
in class com.fasterxml.jackson.databind.JsonDeserializer<javax.ws.rs.core.Link>
IOException
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/PackageVersion.html new file mode 100644 index 00000000..e0382c6d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/PackageVersion.html @@ -0,0 +1,321 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/Jaxrs2TypesModule.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/Jaxrs2TypesModule.html new file mode 100644 index 00000000..81002f13 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/Jaxrs2TypesModule.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/LinkDeserializer.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/LinkDeserializer.html new file mode 100644 index 00000000..74583a7a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/LinkDeserializer.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/PackageVersion.html new file mode 100644 index 00000000..0680b9d8 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-frame.html new file mode 100644 index 00000000..2069dcf9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +Class | +Description | +
---|---|
Jaxrs2TypesModule | +
+ Simple datatype module that adds serialization and deserialization
+ support for following JAX-RS 2.0 types:
+
+
+Link : serialized using "link header" representation
+
+ |
+
LinkDeserializer | ++ |
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in
+ pom.xml.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-tree.html new file mode 100644 index 00000000..e596b8dd --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-use.html new file mode 100644 index 00000000..9ba94437 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/datatype/jaxrs/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/JacksonFeatures.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/JacksonFeatures.html new file mode 100644 index 00000000..e05e3e20 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/JacksonFeatures.html @@ -0,0 +1,293 @@ + + + + + + +@Target(value={ANNOTATION_TYPE,METHOD,PARAMETER}) + @Retention(value=RUNTIME) +public @interface JacksonFeatures+
ObjectReader
s and ObjectWriter
s.Modifier and Type | +Optional Element and Description | +
---|---|
com.fasterxml.jackson.databind.DeserializationFeature[] |
+deserializationDisable
+Deserialization features to disable.
+ |
+
com.fasterxml.jackson.databind.DeserializationFeature[] |
+deserializationEnable
+Deserialization features to enable.
+ |
+
com.fasterxml.jackson.databind.SerializationFeature[] |
+serializationDisable
+Serialization features to disable.
+ |
+
com.fasterxml.jackson.databind.SerializationFeature[] |
+serializationEnable
+Serialization features to enable.
+ |
+
public abstract com.fasterxml.jackson.databind.DeserializationFeature[] deserializationEnable+
public abstract com.fasterxml.jackson.databind.DeserializationFeature[] deserializationDisable+
public abstract com.fasterxml.jackson.databind.SerializationFeature[] serializationEnable+
public abstract com.fasterxml.jackson.databind.SerializationFeature[] serializationDisable+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/class-use/JacksonFeatures.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/class-use/JacksonFeatures.html new file mode 100644 index 00000000..f73b4641 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/class-use/JacksonFeatures.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-frame.html new file mode 100644 index 00000000..ca7eda1e --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +See: Description
+Annotation Type | +Description | +
---|---|
JacksonFeatures | +
+ Annotation that can be used enable and/or disable various
+ features for
+ObjectReader s and ObjectWriter s. |
+
JacksonFeatures
allows
+ enabling and/or disabling DeserializationFeature
s
+ and SerializationFeature
s for individual
+ endpoints.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-tree.html new file mode 100644 index 00000000..64d00f22 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-tree.html @@ -0,0 +1,135 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-use.html new file mode 100644 index 00000000..eb72df7f --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/annotation/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonMappingExceptionMapper.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonMappingExceptionMapper.html new file mode 100644 index 00000000..a8c97def --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonMappingExceptionMapper.html @@ -0,0 +1,291 @@ + + + + + + +public class JsonMappingExceptionMapper +extends Object +implements javax.ws.rs.ext.ExceptionMapper<com.fasterxml.jackson.databind.JsonMappingException>+
ExceptionMapper
to send down a "400 Bad Request"
+ response in the event that unmappable JSON is received.
+
+ Note that Provider
annotation was include up to
+ Jackson 2.7, but removed from 2.8 (as per [jaxrs-providers#22]
Constructor and Description | +
---|
JsonMappingExceptionMapper() |
+
Modifier and Type | +Method and Description | +
---|---|
javax.ws.rs.core.Response |
+toResponse(com.fasterxml.jackson.databind.JsonMappingException exception) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonParseExceptionMapper.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonParseExceptionMapper.html new file mode 100644 index 00000000..cf61deb0 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/JsonParseExceptionMapper.html @@ -0,0 +1,291 @@ + + + + + + +public class JsonParseExceptionMapper +extends Object +implements javax.ws.rs.ext.ExceptionMapper<com.fasterxml.jackson.core.JsonParseException>+
ExceptionMapper
to send down a "400 Bad Request"
+ in the event unparsable JSON is received.
+
+ Note that Provider
annotation was include up to
+ Jackson 2.7, but removed from 2.8 (as per [jaxrs-providers#22]
Constructor and Description | +
---|
JsonParseExceptionMapper() |
+
Modifier and Type | +Method and Description | +
---|---|
javax.ws.rs.core.Response |
+toResponse(com.fasterxml.jackson.core.JsonParseException exception) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/ProviderBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/ProviderBase.html new file mode 100644 index 00000000..fc793483 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/ProviderBase.html @@ -0,0 +1,1804 @@ + + + + + + +public abstract class ProviderBase<THIS extends ProviderBase<THIS,MAPPER,EP_CONFIG,MAPPER_CONFIG>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>,MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER>> +extends Object +implements javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>, com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
protected boolean |
+_cfgCheckCanDeserialize
+Whether we want to actually check that Jackson has
+ a deserializer for given type.
+ |
+
protected boolean |
+_cfgCheckCanSerialize
+Whether we want to actually check that Jackson has
+ a serializer for given type.
+ |
+
protected HashMap<ClassKey,Boolean> |
+_cfgCustomUntouchables
+Map that contains overrides to default list of untouchable
+ types:
+true meaning that entry is untouchable,
+ false that is is not. |
+
protected Class<?> |
+_defaultReadView
+View to use for reading if none defined for the end point.
+ |
+
protected Class<?> |
+_defaultWriteView
+View to use for writing if none defined for the end point.
+ |
+
protected int |
+_jaxRSFeatures
+Feature flags set.
+ |
+
protected MAPPER_CONFIG |
+_mapperConfig
+Helper object used for encapsulating configuration aspects
+ of
+ObjectMapper |
+
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+_readers
+Cache for resolved endpoint configurations when reading JSON data
+ |
+
static Class<?>[] |
+_unreadableClasses |
+
static HashSet<ClassKey> |
+_untouchables |
+
static Class<?>[] |
+_unwritableClasses |
+
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+_writers
+Cache for resolved endpoint configurations when writing JSON data
+ |
+
protected static String |
+CLASS_NAME_NO_CONTENT_EXCEPTION |
+
static Class<?>[] |
+DEFAULT_UNREADABLES
+These are classes that we never use for reading
+ (never try to deserialize instances of these types).
+ |
+
protected static HashSet<ClassKey> |
+DEFAULT_UNTOUCHABLES
+Looks like we need to worry about accidental
+ data binding for types we shouldn't be handling.
+ |
+
static Class<?>[] |
+DEFAULT_UNWRITABLES
+These are classes that we never use for writing
+ (never try to serialize instances of these types).
+ |
+
static String |
+HEADER_CONTENT_TYPE_OPTIONS
+This header is useful on Windows, trying to deal with potential XSS attacks.
+ |
+
protected static int |
+JAXRS_FEATURE_DEFAULTS |
+
Modifier | +Constructor and Description | +
---|---|
protected |
+ProviderBase()
+Deprecated.
+ |
+
protected |
+ProviderBase(MAPPER_CONFIG mconfig) |
+
Modifier and Type | +Method and Description | +
---|---|
protected static void |
+_addSuperTypes(Class<?> cls,
+ Class<?> endBefore,
+ Collection<Class<?>> result,
+ boolean addClassItself) |
+
protected EP_CONFIG |
+_configForReading(MAPPER mapper,
+ Annotation[] annotations,
+ Class<?> defaultView) |
+
protected abstract EP_CONFIG |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected EP_CONFIG |
+_configForWriting(MAPPER mapper,
+ Annotation[] annotations,
+ Class<?> defaultView) |
+
protected abstract EP_CONFIG |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected static boolean |
+_containedIn(Class<?> mainType,
+ HashSet<ClassKey> set) |
+
protected com.fasterxml.jackson.core.JsonGenerator |
+_createGenerator(com.fasterxml.jackson.databind.ObjectWriter writer,
+ OutputStream rawStream,
+ com.fasterxml.jackson.core.JsonEncoding enc)
+Overridable helper method called to create a
+JsonGenerator for writing
+ contents into given raw OutputStream . |
+
protected IOException |
+_createNoContentException() |
+
protected com.fasterxml.jackson.core.JsonParser |
+_createParser(com.fasterxml.jackson.databind.ObjectReader reader,
+ InputStream rawStream)
+Overridable helper method called to create a
+JsonParser for reading
+ contents of given raw InputStream . |
+
protected EP_CONFIG |
+_endpointForReading(Class<Object> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType,
+ javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)
+Overridable helper method that will basically fetch representation of the
+ endpoint that can be used to get
+ObjectReader to use for deserializing
+ content |
+
protected EP_CONFIG |
+_endpointForWriting(Object value,
+ Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType,
+ javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders) |
+
protected Boolean |
+_findCustomUntouchable(Class<?> mainType) |
+
protected boolean |
+_isIgnorableForReading(ClassKey typeKey)
+Overridable helper method called to check whether given type is a known
+ "ignorable type" (in context of reading), values of which are not bound
+ from content.
+ |
+
protected boolean |
+_isIgnorableForWriting(ClassKey typeKey)
+Overridable helper method called to check whether given type is a known
+ "ignorable type" (in context of reading), values of which
+ can not be written out.
+ |
+
protected boolean |
+_isSpecialReadable(Class<?> type)
+Overridable helper method used to allow handling of somewhat special
+ types for reading
+ |
+
protected abstract MAPPER |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Helper method that is called if no mapper has been explicitly configured.
+ |
+
protected void |
+_modifyHeaders(Object value,
+ Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
+ EP_CONFIG endpoint)
+Overridable method used for adding optional response headers before
+ serializing response object.
+ |
+
void |
+addUntouchable(Class<?> type)
+Method for marking specified type as "untouchable", meaning that provider
+ will not try to read or write values of this type (or its subtypes).
+ |
+
void |
+checkCanDeserialize(boolean state)
+Method for defining whether actual detection for existence of
+ a deserializer for type should be done when
+isReadable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called. |
+
void |
+checkCanSerialize(boolean state)
+Method for defining whether actual detection for existence of
+ a serializer for type should be done when
+isWriteable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called. |
+
THIS |
+configure(com.fasterxml.jackson.databind.DeserializationFeature f,
+ boolean state) |
+
THIS |
+configure(JaxRSFeature feature,
+ boolean state) |
+
THIS |
+configure(com.fasterxml.jackson.core.JsonGenerator.Feature f,
+ boolean state) |
+
THIS |
+configure(com.fasterxml.jackson.core.JsonParser.Feature f,
+ boolean state) |
+
THIS |
+configure(com.fasterxml.jackson.databind.SerializationFeature f,
+ boolean state) |
+
THIS |
+disable(com.fasterxml.jackson.databind.DeserializationFeature f) |
+
THIS |
+disable(JaxRSFeature feature) |
+
THIS |
+disable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
THIS |
+disable(com.fasterxml.jackson.core.JsonGenerator.Feature f) |
+
THIS |
+disable(com.fasterxml.jackson.core.JsonParser.Feature f) |
+
THIS |
+disable(com.fasterxml.jackson.databind.SerializationFeature f) |
+
THIS |
+enable(com.fasterxml.jackson.databind.DeserializationFeature f) |
+
THIS |
+enable(JaxRSFeature feature) |
+
THIS |
+enable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
THIS |
+enable(com.fasterxml.jackson.core.JsonGenerator.Feature f) |
+
THIS |
+enable(com.fasterxml.jackson.core.JsonParser.Feature f) |
+
THIS |
+enable(com.fasterxml.jackson.databind.SerializationFeature f) |
+
protected com.fasterxml.jackson.core.JsonEncoding |
+findEncoding(javax.ws.rs.core.MediaType mediaType,
+ javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders)
+Helper method to use for determining desired output encoding.
+ |
+
protected static List<Class<?>> |
+findSuperTypes(Class<?> cls,
+ Class<?> endBefore) |
+
protected static List<Class<?>> |
+findSuperTypes(Class<?> cls,
+ Class<?> endBefore,
+ List<Class<?>> result) |
+
long |
+getSize(Object value,
+ Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType)
+Method that JAX-RS container calls to try to figure out
+ serialized length of given value.
+ |
+
protected abstract boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is supported by this provider.
+ |
+
protected boolean |
+hasMatchingMediaTypeForReading(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is supported by this provider for read operations
+ (when binding input data such as POST body).
+ |
+
protected boolean |
+hasMatchingMediaTypeForWriting(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is supported by this provider for writing operations,
+ such as when converting response object to response
+ body of request (like GET or POST).
+ |
+
boolean |
+isEnabled(JaxRSFeature f) |
+
boolean |
+isReadable(Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType)
+Method that JAX-RS container calls to try to check whether
+ values of given type (and media type) can be deserialized by
+ this provider.
+ |
+
boolean |
+isWriteable(Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType)
+Method that JAX-RS container calls to try to check whether
+ given value (of specified type) can be serialized by
+ this provider.
+ |
+
MAPPER |
+locateMapper(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Method called to locate
+ObjectMapper to use for serialization
+ and deserialization. |
+
Object |
+readFrom(Class<Object> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType,
+ javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
+ InputStream entityStream)
+Method that JAX-RS container calls to deserialize given value.
+ |
+
void |
+removeUntouchable(Class<?> type)
+Method for removing definition of specified type as untouchable:
+ usually only
+ |
+
void |
+setAnnotationsToUse(Annotations[] annotationsToUse)
+Method for configuring which annotation sets to use (including none).
+ |
+
THIS |
+setDefaultReadView(Class<?> view)
+Method for specifying JSON View to use for reading content
+ when end point does not have explicit View annotations.
+ |
+
THIS |
+setDefaultView(Class<?> view)
+Method for specifying JSON View to use for reading and writing content
+ when end point does not have explicit View annotations.
+ |
+
THIS |
+setDefaultWriteView(Class<?> view)
+Method for specifying JSON View to use for reading content
+ when end point does not have explicit View annotations.
+ |
+
void |
+setMapper(MAPPER m)
+Method that can be used to directly define
+ObjectMapper to use
+ for serialization and deserialization; if null, will use the standard
+ provider discovery from context instead. |
+
void |
+writeTo(Object value,
+ Class<?> type,
+ Type genericType,
+ Annotation[] annotations,
+ javax.ws.rs.core.MediaType mediaType,
+ javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
+ OutputStream entityStream)
+Method that JAX-RS container calls to serialize given value.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
version
public static final String HEADER_CONTENT_TYPE_OPTIONS+
protected static final String CLASS_NAME_NO_CONTENT_EXCEPTION+
protected static final HashSet<ClassKey> DEFAULT_UNTOUCHABLES+
+ (why ClassKey? since plain old Class has no hashCode() defined, + lookups are painfully slow)
public static final Class<?>[] DEFAULT_UNREADABLES+
public static final Class<?>[] DEFAULT_UNWRITABLES+
protected static final int JAXRS_FEATURE_DEFAULTS+
protected final MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER> _mapperConfig+
ObjectMapper
protected HashMap<ClassKey,Boolean> _cfgCustomUntouchables+
true
meaning that entry is untouchable,
+ false
that is is not.protected boolean _cfgCheckCanSerialize+
protected boolean _cfgCheckCanDeserialize+
protected int _jaxRSFeatures+
protected Class<?> _defaultReadView+
protected Class<?> _defaultWriteView+
public static final Class<?>[] _unreadableClasses+
public static final Class<?>[] _unwritableClasses+
protected final LRUMap<AnnotationBundleKey,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>> _readers+
protected final LRUMap<AnnotationBundleKey,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>> _writers+
protected ProviderBase(MAPPER_CONFIG mconfig)+
@Deprecated +protected ProviderBase()+
public void checkCanDeserialize(boolean state)+
isReadable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called.public void checkCanSerialize(boolean state)+
isWriteable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called.public void addUntouchable(Class<?> type)+
type
- Type to consider untouchable; can be any kind of class,
+ including abstract class or interface. No instance of this type
+ (including subtypes, i.e. types assignable to this type) will
+ be read or written by providerpublic void removeUntouchable(Class<?> type)+
public void setAnnotationsToUse(Annotations[] annotationsToUse)+
annotationsToUse
- Ordered list of annotation sets to use; if null,
+ defaultpublic void setMapper(MAPPER m)+
ObjectMapper
to use
+ for serialization and deserialization; if null, will use the standard
+ provider discovery from context instead. Default setting is null.public THIS setDefaultReadView(Class<?> view)+
public THIS setDefaultWriteView(Class<?> view)+
public THIS setDefaultView(Class<?> view)+
+ setDefaultReadView(view);
+ setDefaultWriteView(view);
+
public THIS configure(JaxRSFeature feature, + boolean state)+
public THIS enable(JaxRSFeature feature)+
public THIS enable(JaxRSFeature first, + JaxRSFeature... f2)+
public THIS disable(JaxRSFeature feature)+
public THIS disable(JaxRSFeature first, + JaxRSFeature... f2)+
public boolean isEnabled(JaxRSFeature f)+
public THIS configure(com.fasterxml.jackson.databind.DeserializationFeature f, + boolean state)+
public THIS enable(com.fasterxml.jackson.databind.DeserializationFeature f)+
public THIS disable(com.fasterxml.jackson.databind.DeserializationFeature f)+
public THIS configure(com.fasterxml.jackson.databind.SerializationFeature f, + boolean state)+
public THIS enable(com.fasterxml.jackson.databind.SerializationFeature f)+
public THIS disable(com.fasterxml.jackson.databind.SerializationFeature f)+
public THIS enable(com.fasterxml.jackson.core.JsonParser.Feature f)+
public THIS enable(com.fasterxml.jackson.core.JsonGenerator.Feature f)+
public THIS disable(com.fasterxml.jackson.core.JsonParser.Feature f)+
public THIS disable(com.fasterxml.jackson.core.JsonGenerator.Feature f)+
public THIS configure(com.fasterxml.jackson.core.JsonParser.Feature f, + boolean state)+
public THIS configure(com.fasterxml.jackson.core.JsonGenerator.Feature f, + boolean state)+
protected boolean hasMatchingMediaTypeForReading(javax.ws.rs.core.MediaType mediaType)+
+ Default implementation simply calls hasMatchingMediaType(javax.ws.rs.core.MediaType)
.
protected boolean hasMatchingMediaTypeForWriting(javax.ws.rs.core.MediaType mediaType)+
+ Default implementation simply calls hasMatchingMediaType(javax.ws.rs.core.MediaType)
.
protected abstract boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
protected abstract MAPPER _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
protected EP_CONFIG _configForReading(MAPPER mapper, + Annotation[] annotations, + Class<?> defaultView)+
protected EP_CONFIG _configForWriting(MAPPER mapper, + Annotation[] annotations, + Class<?> defaultView)+
protected abstract EP_CONFIG _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
protected abstract EP_CONFIG _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
public long getSize(Object value, + Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType)+
getSize
in interface javax.ws.rs.ext.MessageBodyWriter<Object>
public boolean isWriteable(Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType)+
hasMatchingMediaType(javax.ws.rs.core.MediaType)
); then verify
+ that type is not one of "untouchable" types (types we will never
+ automatically handle), and finally that there is a serializer
+ for type (iff checkCanSerialize(boolean)
has been called with
+ true argument -- otherwise assumption is there will be a handler)isWriteable
in interface javax.ws.rs.ext.MessageBodyWriter<Object>
public void writeTo(Object value, + Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType, + javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, + OutputStream entityStream) + throws IOException+
writeTo
in interface javax.ws.rs.ext.MessageBodyWriter<Object>
IOException
protected com.fasterxml.jackson.core.JsonEncoding findEncoding(javax.ws.rs.core.MediaType mediaType, + javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders)+
protected void _modifyHeaders(Object value, + Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, + EP_CONFIG endpoint) + throws IOException+
IOException
protected com.fasterxml.jackson.core.JsonGenerator _createGenerator(com.fasterxml.jackson.databind.ObjectWriter writer, + OutputStream rawStream, + com.fasterxml.jackson.core.JsonEncoding enc) + throws IOException+
JsonGenerator
for writing
+ contents into given raw OutputStream
.IOException
protected EP_CONFIG _endpointForWriting(Object value, + Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType, + javax.ws.rs.core.MultivaluedMap<String,Object> httpHeaders)+
public boolean isReadable(Class<?> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType)+
hasMatchingMediaType(javax.ws.rs.core.MediaType)
);
+ then verify
+ that type is not one of "untouchable" types (types we will never
+ automatically handle), and finally that there is a deserializer
+ for type (iff checkCanDeserialize(boolean)
has been called with
+ true argument -- otherwise assumption is there will be a handler)isReadable
in interface javax.ws.rs.ext.MessageBodyReader<Object>
public Object readFrom(Class<Object> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType, + javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, + InputStream entityStream) + throws IOException+
readFrom
in interface javax.ws.rs.ext.MessageBodyReader<Object>
IOException
protected com.fasterxml.jackson.core.JsonParser _createParser(com.fasterxml.jackson.databind.ObjectReader reader, + InputStream rawStream) + throws IOException+
JsonParser
for reading
+ contents of given raw InputStream
.
+ May return null to indicate that Stream is empty; that is, contains no
+ content.IOException
protected EP_CONFIG _endpointForReading(Class<Object> type, + Type genericType, + Annotation[] annotations, + javax.ws.rs.core.MediaType mediaType, + javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders)+
ObjectReader
to use for deserializing
+ contentpublic MAPPER locateMapper(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
ObjectMapper
to use for serialization
+ and deserialization. Exact logic depends on setting of
+ JaxRSFeature.DYNAMIC_OBJECT_MAPPER_LOOKUP
.
+
+
+ If JaxRSFeature.DYNAMIC_OBJECT_MAPPER_LOOKUP
is disabled (default
+ setting unless changed), behavior is as follows:
+
setMapper(MAPPER)
(or non-null instance passed in constructor), that
+ will be used.
+ ContextResolver
mechanism, if it has been properly configured
+ to access it (by JAX-RS runtime).
+ ObjectMapper
instance (one constructed with default constructor
+ and not modified in any way)
+
+ If JaxRSFeature.DYNAMIC_OBJECT_MAPPER_LOOKUP
is enabled, steps
+ 1 and 2 are reversed, such that JAX-RS ContextResolver
+ is first used, and only if none is defined will configured mapper be used.
type
- Class of object being serialized or deserialized;
+ not checked at this point, since it is assumed that unprocessable
+ classes have been already weeded out,
+ but will be passed to ContextResolver
as is.mediaType
- Declared media type for the instance to process:
+ not used by this method,
+ but will be passed to ContextResolver
as is.protected boolean _isSpecialReadable(Class<?> type)+
protected boolean _isIgnorableForReading(ClassKey typeKey)+
protected boolean _isIgnorableForWriting(ClassKey typeKey)+
protected IOException _createNoContentException()+
protected static boolean _containedIn(Class<?> mainType, + HashSet<ClassKey> set)+
protected static List<Class<?>> findSuperTypes(Class<?> cls, + Class<?> endBefore)+
protected static List<Class<?>> findSuperTypes(Class<?> cls, + Class<?> endBefore, + List<Class<?>> result)+
protected static void _addSuperTypes(Class<?> cls, + Class<?> endBefore, + Collection<Class<?>> result, + boolean addClassItself)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonMappingExceptionMapper.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonMappingExceptionMapper.html new file mode 100644 index 00000000..e05a097d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonMappingExceptionMapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonParseExceptionMapper.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonParseExceptionMapper.html new file mode 100644 index 00000000..d8c70cf4 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/JsonParseExceptionMapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/ProviderBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/ProviderBase.html new file mode 100644 index 00000000..1c2f1b41 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/class-use/ProviderBase.html @@ -0,0 +1,351 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+ProviderBase<THIS extends ProviderBase<THIS,MAPPER,EP_CONFIG,MAPPER_CONFIG>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>,MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER>> |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonCBORProvider
+Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
class |
+JacksonJaxbCBORProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbJsonProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
class |
+JacksonJsonProvider
+Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbSmileProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
class |
+JacksonSmileProvider
+Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbXMLProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
class |
+JacksonXMLProvider
+Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbYAMLProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
class |
+JacksonYAMLProvider
+Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-frame.html new file mode 100644 index 00000000..f228694a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +Class | +Description | +
---|---|
JsonMappingExceptionMapper | +
+ Implementation if
+ExceptionMapper to send down a "400 Bad Request"
+ response in the event that unmappable JSON is received. |
+
JsonParseExceptionMapper | +
+ Implementation of
+ExceptionMapper to send down a "400 Bad Request"
+ in the event unparsable JSON is received. |
+
ProviderBase<THIS extends ProviderBase<THIS,MAPPER,EP_CONFIG,MAPPER_CONFIG>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>,MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER>> | ++ |
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-tree.html new file mode 100644 index 00000000..1bac64ff --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-tree.html @@ -0,0 +1,141 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-use.html new file mode 100644 index 00000000..f0cf12c2 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/base/package-use.html @@ -0,0 +1,274 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Class and Description | +
---|
ProviderBase | +
Class and Description | +
---|
ProviderBase | +
Class and Description | +
---|
ProviderBase | +
Class and Description | +
---|
ProviderBase | +
Class and Description | +
---|
ProviderBase | +
Class and Description | +
---|
ProviderBase | +
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBOREndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBOREndpointConfig.html new file mode 100644 index 00000000..af0b91e3 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBOREndpointConfig.html @@ -0,0 +1,338 @@ + + + + + + +public class CBOREndpointConfig +extends EndpointConfigBase<CBOREndpointConfig>+
_activeView, _config, _deserDisable, _deserEnable, _reader, _rootName, _serDisable, _serEnable, _writer
Modifier | +Constructor and Description | +
---|---|
protected |
+CBOREndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
static CBOREndpointConfig |
+forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static CBOREndpointConfig |
+forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Object |
+modifyBeforeWrite(Object value) |
+
add, addAnnotation, getActiveView, getReader, getRootName, getWriter, initReader, initWriter, nullIfEmpty
protected CBOREndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
public static CBOREndpointConfig forReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
public static CBOREndpointConfig forWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
public Object modifyBeforeWrite(Object value)+
modifyBeforeWrite
in class EndpointConfigBase<CBOREndpointConfig>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMapperConfigurator.html new file mode 100644 index 00000000..2658b458 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMapperConfigurator.html @@ -0,0 +1,383 @@ + + + + + + +public class CBORMapperConfigurator +extends MapperConfiguratorBase<CBORMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>+
ObjectMapper
instance to be used for data binding, as
+ well as accessing it._defaultAnnotationsToUse, _defaultMapper, _jaxbIntrospectorClass, _mapper
Constructor and Description | +
---|
CBORMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getConfiguredMapper()
+Method that locates, configures and returns
+ObjectMapper to use |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getDefaultMapper() |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
_setAnnotations, configure, configure, configure, configure, setAnnotationsToUse, setMapper
public CBORMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] defAnnotations)+
public com.fasterxml.jackson.databind.ObjectMapper getConfiguredMapper()+
ObjectMapper
to usegetConfiguredMapper
in class MapperConfiguratorBase<CBORMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
public com.fasterxml.jackson.databind.ObjectMapper getDefaultMapper()+
getDefaultMapper
in class MapperConfiguratorBase<CBORMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.ObjectMapper mapper()+
mapper
in class MapperConfiguratorBase<CBORMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
_resolveIntrospectors
in class MapperConfiguratorBase<CBORMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospector(Annotations ann)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMediaTypes.html new file mode 100644 index 00000000..da32a7bc --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/CBORMediaTypes.html @@ -0,0 +1,292 @@ + + + + + + +public class CBORMediaTypes +extends Object+
Modifier and Type | +Field and Description | +
---|---|
static String |
+APPLICATION_JACKSON_CBOR |
+
static javax.ws.rs.core.MediaType |
+APPLICATION_JACKSON_CBOR_TYPE |
+
Constructor and Description | +
---|
CBORMediaTypes() |
+
public static final String APPLICATION_JACKSON_CBOR+
public static final javax.ws.rs.core.MediaType APPLICATION_JACKSON_CBOR_TYPE+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonCBORProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonCBORProvider.html new file mode 100644 index 00000000..93b564d9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonCBORProvider.html @@ -0,0 +1,565 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonCBORProvider +extends ProviderBase<JacksonCBORProvider,com.fasterxml.jackson.databind.ObjectMapper,CBOREndpointConfig,CBORMapperConfigurator>+
MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s).
+
+ Actual data binding functionality is implemented by ObjectMapper
:
+ mapper to use can be configured in multiple ways:
+
ProviderBase.setMapper(MAPPER)
+ Provider
that returns ObjectMapper
s.
+
+ Note that the default mapper instance will be automatically created if
+ one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jaxrs.cfg.JaxRSFeature, boolean)
)
+ is called: if so, Provider-based introspection is NOT used, but the
+ resulting Mapper is used as configured.
+
+ Note that there is also a sub-class -- (JacksonJaxbCBORProvider
) -- that
+ is configured by default to use both Jackson and JAXB annotations for configuration
+ (base class when used as-is defaults to using just Jackson annotations)
Modifier and Type | +Field and Description | +
---|---|
protected javax.ws.rs.ext.Providers |
+_providers
+Injectable context object used to locate configured
+ instance of
+ObjectMapper to use for actual
+ serialization. |
+
static Annotations[] |
+BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonCBORProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonCBORProvider(Annotations... annotationsToUse) |
+
JacksonCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper) |
+
JacksonCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected CBOREndpointConfig |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected CBOREndpointConfig |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Method called to locate
+ObjectMapper to use for serialization
+ and deserialization. |
+
protected boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is Smile type or sub type.
+ |
+
com.fasterxml.jackson.core.Version |
+version()
+Method that will return version information stored in and read from jar
+ that contains this class.
+ |
+
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] BASIC_ANNOTATIONS+
@Context +protected javax.ws.rs.ext.Providers _providers+
ObjectMapper
to use for actual
+ serialization.public JacksonCBORProvider()+
public JacksonCBORProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper)+
public JacksonCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
annotationsToUse
- Sets of annotations (Jackson, JAXB) that provider should
+ supportpublic com.fasterxml.jackson.core.Version version()+
protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
MediaType.getSubtype()
returns
+ "smile" or something ending with "+smile".hasMatchingMediaType
in class ProviderBase<JacksonCBORProvider,com.fasterxml.jackson.databind.ObjectMapper,CBOREndpointConfig,CBORMapperConfigurator>
protected com.fasterxml.jackson.databind.ObjectMapper _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
ObjectMapper
to use for serialization
+ and deserialization. If an instance has been explicitly defined by
+ ProviderBase.setMapper(MAPPER)
(or non-null instance passed in constructor), that
+ will be used.
+ If not, will try to locate it using standard JAX-RS
+ ContextResolver
mechanism, if it has been properly configured
+ to access it (by JAX-RS runtime).
+ Finally, if no mapper is found, will return a default unconfigured
+ ObjectMapper
instance (one constructed with default constructor
+ and not modified in any way)_locateMapperViaProvider
in class ProviderBase<JacksonCBORProvider,com.fasterxml.jackson.databind.ObjectMapper,CBOREndpointConfig,CBORMapperConfigurator>
type
- Class of object being serialized or deserialized;
+ not checked at this point, since it is assumed that unprocessable
+ classes have been already weeded out,
+ but will be passed to ContextResolver
as is.mediaType
- Declared media type for the instance to process:
+ not used by this method,
+ but will be passed to ContextResolver
as is.protected CBOREndpointConfig _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
_configForReading
in class ProviderBase<JacksonCBORProvider,com.fasterxml.jackson.databind.ObjectMapper,CBOREndpointConfig,CBORMapperConfigurator>
protected CBOREndpointConfig _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
_configForWriting
in class ProviderBase<JacksonCBORProvider,com.fasterxml.jackson.databind.ObjectMapper,CBOREndpointConfig,CBORMapperConfigurator>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonJaxbCBORProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonJaxbCBORProvider.html new file mode 100644 index 00000000..ec298d88 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/JacksonJaxbCBORProvider.html @@ -0,0 +1,382 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJaxbCBORProvider +extends JacksonCBORProvider+
JacksonCBORProvider
.
++ Typical usage pattern is to just instantiate instance of this + provider for JAX-RS and use as is: this will use both Jackson and + JAXB annotations (with Jackson annotations having priority). +
+ Note: class annotations are duplicated from super class, since it + is not clear whether JAX-RS implementations are required to + check settings of super-classes. It is important to keep annotations + in sync if changed.
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
_providers, BASIC_ANNOTATIONS
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJaxbCBORProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJaxbCBORProvider(Annotations... annotationsToUse) |
+
JacksonJaxbCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
_configForReading, _configForWriting, _locateMapperViaProvider, hasMatchingMediaType, version
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] DEFAULT_ANNOTATIONS+
public JacksonJaxbCBORProvider()+
public JacksonJaxbCBORProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJaxbCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/PackageVersion.html new file mode 100644 index 00000000..daf86879 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/PackageVersion.html @@ -0,0 +1,320 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBOREndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBOREndpointConfig.html new file mode 100644 index 00000000..34de6163 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBOREndpointConfig.html @@ -0,0 +1,186 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected CBOREndpointConfig |
+JacksonCBORProvider._configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected CBOREndpointConfig |
+JacksonCBORProvider._configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
static CBOREndpointConfig |
+CBOREndpointConfig.forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static CBOREndpointConfig |
+CBOREndpointConfig.forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMapperConfigurator.html new file mode 100644 index 00000000..5428482e --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMapperConfigurator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMediaTypes.html new file mode 100644 index 00000000..65fe511d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/CBORMediaTypes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonCBORProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonCBORProvider.html new file mode 100644 index 00000000..8f8a7c35 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonCBORProvider.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbCBORProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonJaxbCBORProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonJaxbCBORProvider.html new file mode 100644 index 00000000..78738c3f --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/JacksonJaxbCBORProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/PackageVersion.html new file mode 100644 index 00000000..5fd1bf54 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-frame.html new file mode 100644 index 00000000..84dd7bb9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
CBOREndpointConfig | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
CBORMapperConfigurator | +
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
CBORMediaTypes | ++ |
JacksonCBORProvider | +
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
JacksonJaxbCBORProvider | +
+ JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in pom.xml.
+ |
+
+ Also continues supporting functionality, such as + exception mappers that can simplify handling of + error conditions. +
+ There are two default provider classes: +
JacksonCBORProvider
is the basic
+ provider configured to use Jackson annotations
+ JacksonJaxbCBORProvider
is extension
+ of the basic provider, configured to additionally use JAXB annotations,
+ in addition to (or in addition of, if so configured) Jackson annotations.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-tree.html new file mode 100644 index 00000000..aa223a9a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-use.html new file mode 100644 index 00000000..bb5af62b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cbor/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
Class and Description | +
---|
CBOREndpointConfig
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
JacksonCBORProvider
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/AnnotationBundleKey.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/AnnotationBundleKey.html new file mode 100644 index 00000000..d8e36e70 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/AnnotationBundleKey.html @@ -0,0 +1,339 @@ + + + + + + +public final class AnnotationBundleKey +extends Object+
Constructor and Description | +
---|
AnnotationBundleKey(Annotation[] annotations,
+ Class<?> type) |
+
Modifier and Type | +Method and Description | +
---|---|
boolean |
+equals(Object o) |
+
int |
+hashCode() |
+
AnnotationBundleKey |
+immutableKey()
+Method called to create a safe immutable copy of the key; used when
+ adding entry with this key -- lookups are ok without calling the method.
+ |
+
String |
+toString() |
+
public AnnotationBundleKey(Annotation[] annotations, + Class<?> type)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/Annotations.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/Annotations.html new file mode 100644 index 00000000..f84c25ae --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/Annotations.html @@ -0,0 +1,361 @@ + + + + + + +public enum Annotations +extends Enum<Annotations>+
Enum Constant and Description | +
---|
JACKSON
+Standard Jackson annotations, defined in Jackson core and databind
+ packages
+ |
+
JAXB
+Standard JAXB annotations, used in a way that approximates expected
+ definitions (since JAXB defines XML aspects, not all features map
+ well to JSON handling)
+ |
+
Modifier and Type | +Method and Description | +
---|---|
static Annotations |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Annotations[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final Annotations JACKSON+
public static final Annotations JAXB+
public static Annotations[] values()+
+for (Annotations c : Annotations.values()) + System.out.println(c); +
public static Annotations valueOf(String name)+
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullCopyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/EndpointConfigBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/EndpointConfigBase.html new file mode 100644 index 00000000..b8f86cf4 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/EndpointConfigBase.html @@ -0,0 +1,558 @@ + + + + + + +public abstract class EndpointConfigBase<THIS extends EndpointConfigBase<THIS>> +extends Object+
Modifier and Type | +Field and Description | +
---|---|
protected Class<?> |
+_activeView |
+
protected com.fasterxml.jackson.databind.cfg.MapperConfig<?> |
+_config |
+
protected com.fasterxml.jackson.databind.DeserializationFeature[] |
+_deserDisable |
+
protected com.fasterxml.jackson.databind.DeserializationFeature[] |
+_deserEnable |
+
protected com.fasterxml.jackson.databind.ObjectReader |
+_reader |
+
protected String |
+_rootName |
+
protected com.fasterxml.jackson.databind.SerializationFeature[] |
+_serDisable |
+
protected com.fasterxml.jackson.databind.SerializationFeature[] |
+_serEnable |
+
protected com.fasterxml.jackson.databind.ObjectWriter |
+_writer |
+
Modifier | +Constructor and Description | +
---|---|
protected |
+EndpointConfigBase(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected THIS |
+add(Annotation[] annotations,
+ boolean forWriting) |
+
protected void |
+addAnnotation(Class<? extends Annotation> type,
+ Annotation annotation,
+ boolean forWriting) |
+
Class<?> |
+getActiveView() |
+
com.fasterxml.jackson.databind.ObjectReader |
+getReader() |
+
String |
+getRootName() |
+
com.fasterxml.jackson.databind.ObjectWriter |
+getWriter() |
+
protected THIS |
+initReader(com.fasterxml.jackson.databind.ObjectReader reader) |
+
protected THIS |
+initWriter(com.fasterxml.jackson.databind.ObjectWriter writer) |
+
abstract Object |
+modifyBeforeWrite(Object value) |
+
protected static <T> T[] |
+nullIfEmpty(T[] arg) |
+
protected final com.fasterxml.jackson.databind.cfg.MapperConfig<?> _config+
protected Class<?> _activeView+
protected String _rootName+
protected com.fasterxml.jackson.databind.DeserializationFeature[] _deserEnable+
protected com.fasterxml.jackson.databind.DeserializationFeature[] _deserDisable+
protected com.fasterxml.jackson.databind.ObjectReader _reader+
protected com.fasterxml.jackson.databind.SerializationFeature[] _serEnable+
protected com.fasterxml.jackson.databind.SerializationFeature[] _serDisable+
protected com.fasterxml.jackson.databind.ObjectWriter _writer+
protected EndpointConfigBase(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
protected THIS add(Annotation[] annotations, + boolean forWriting)+
protected void addAnnotation(Class<? extends Annotation> type, + Annotation annotation, + boolean forWriting)+
protected THIS initReader(com.fasterxml.jackson.databind.ObjectReader reader)+
protected THIS initWriter(com.fasterxml.jackson.databind.ObjectWriter writer)+
public String getRootName()+
public Class<?> getActiveView()+
public final com.fasterxml.jackson.databind.ObjectReader getReader()+
public final com.fasterxml.jackson.databind.ObjectWriter getWriter()+
protected static <T> T[] nullIfEmpty(T[] arg)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/JaxRSFeature.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/JaxRSFeature.html new file mode 100644 index 00000000..055bf9d5 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/JaxRSFeature.html @@ -0,0 +1,516 @@ + + + + + + +public enum JaxRSFeature +extends Enum<JaxRSFeature> +implements com.fasterxml.jackson.databind.cfg.ConfigFeature+
Enum Constant and 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 related to
+ Issue #49:
+ whether empty input is considered legal or not.
+ |
+
CACHE_ENDPOINT_READERS
+[jaxrs-providers#86]: Feature that determines whether provider will cache endpoint
+ definitions for reading or not (including caching of actual
+ObjectReader to use). |
+
CACHE_ENDPOINT_WRITERS
+[jaxrs-providers#86]: 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 JAX-RS Provider interface, regardless of whether MapperConfigurator
+ has explicitly configured mapper or not; if disabled, static configuration will
+ take precedence. |
+
Modifier and Type | +Method and Description | +
---|---|
static int |
+collectDefaults() |
+
boolean |
+enabledByDefault() |
+
boolean |
+enabledIn(int flags) |
+
int |
+getMask() |
+
static JaxRSFeature |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static JaxRSFeature[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final JaxRSFeature ALLOW_EMPTY_INPUT+
IOException
will be thrown.
+
+ NOTE: in case of JAX-RS 2.0, specific exception will be javax.ws.rs.core.NoContentException
;
+ but this is not defined in JAX-RS 1.x.
public static final JaxRSFeature ADD_NO_SNIFF_HEADER+
+ Feature is disabled by default.
public static final JaxRSFeature DYNAMIC_OBJECT_MAPPER_LOOKUP+
ObjectMapper
+ via JAX-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.
public static final JaxRSFeature CACHE_ENDPOINT_READERS+
ObjectReader
to use).
+ Feature may be disabled if reconfiguration or alternate isntance of ObjectMapper
is needed.
++ Note that disabling of the feature may add significant amount of overhead for processing. +
+ Feature is enabled by default.
public static final JaxRSFeature CACHE_ENDPOINT_WRITERS+
ObjectWriter
to use).
+ Feature may be disabled if reconfiguration or alternate isntance of ObjectMapper
is needed.
++ Note that disabling of the feature may add significant amount of overhead for processing. +
+ Feature is enabled by default.
public static JaxRSFeature[] values()+
+for (JaxRSFeature c : JaxRSFeature.values()) + System.out.println(c); +
public static JaxRSFeature valueOf(String name)+
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static int collectDefaults()+
public boolean enabledByDefault()+
enabledByDefault
in interface com.fasterxml.jackson.databind.cfg.ConfigFeature
public int getMask()+
getMask
in interface com.fasterxml.jackson.databind.cfg.ConfigFeature
public boolean enabledIn(int flags)+
enabledIn
in interface com.fasterxml.jackson.databind.cfg.ConfigFeature
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/MapperConfiguratorBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/MapperConfiguratorBase.html new file mode 100644 index 00000000..ee25a3e9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/MapperConfiguratorBase.html @@ -0,0 +1,535 @@ + + + + + + +public abstract class MapperConfiguratorBase<IMPL extends MapperConfiguratorBase<IMPL,MAPPER>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper> +extends Object+
ObjectMapper
instance to be used for data binding, as
+ well as accessing it.Modifier and Type | +Field and Description | +
---|---|
protected Annotations[] |
+_defaultAnnotationsToUse
+Annotations set to use by default; overridden by explicit call
+ to
+setAnnotationsToUse(com.fasterxml.jackson.jaxrs.cfg.Annotations[]) |
+
protected MAPPER |
+_defaultMapper
+If no mapper was specified when constructed, and no configuration
+ calls are made, a default mapper is constructed.
+ |
+
protected Class<? extends com.fasterxml.jackson.databind.AnnotationIntrospector> |
+_jaxbIntrospectorClass
+To support optional dependency to Jackson JAXB annotations module
+ (needed iff JAXB annotations are used for configuration)
+ |
+
protected MAPPER |
+_mapper
+Mapper provider was constructed with if any, or that was constructed
+ due to a call to explicitly configure mapper.
+ |
+
Constructor and Description | +
---|
MapperConfiguratorBase(MAPPER mapper,
+ Annotations[] defaultAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected abstract com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
protected void |
+_setAnnotations(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse) |
+
void |
+configure(com.fasterxml.jackson.databind.DeserializationFeature f,
+ boolean state) |
+
void |
+configure(com.fasterxml.jackson.core.JsonGenerator.Feature f,
+ boolean state) |
+
void |
+configure(com.fasterxml.jackson.core.JsonParser.Feature f,
+ boolean state) |
+
void |
+configure(com.fasterxml.jackson.databind.SerializationFeature f,
+ boolean state) |
+
abstract MAPPER |
+getConfiguredMapper()
+Method that locates, configures and returns
+ObjectMapper to use |
+
abstract MAPPER |
+getDefaultMapper() |
+
protected abstract MAPPER |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
void |
+setAnnotationsToUse(Annotations[] annotationsToUse) |
+
void |
+setMapper(MAPPER m) |
+
protected MAPPER extends com.fasterxml.jackson.databind.ObjectMapper _mapper+
protected MAPPER extends com.fasterxml.jackson.databind.ObjectMapper _defaultMapper+
protected Annotations[] _defaultAnnotationsToUse+
setAnnotationsToUse(com.fasterxml.jackson.jaxrs.cfg.Annotations[])
protected Class<? extends com.fasterxml.jackson.databind.AnnotationIntrospector> _jaxbIntrospectorClass+
public MapperConfiguratorBase(MAPPER mapper, + Annotations[] defaultAnnotations)+
public abstract MAPPER getConfiguredMapper()+
ObjectMapper
to usepublic abstract MAPPER getDefaultMapper()+
protected abstract MAPPER mapper()+
protected abstract com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
public final void setMapper(MAPPER m)+
public final void setAnnotationsToUse(Annotations[] annotationsToUse)+
public final void configure(com.fasterxml.jackson.databind.DeserializationFeature f, + boolean state)+
public final void configure(com.fasterxml.jackson.databind.SerializationFeature f, + boolean state)+
public final void configure(com.fasterxml.jackson.core.JsonParser.Feature f, + boolean state)+
public final void configure(com.fasterxml.jackson.core.JsonGenerator.Feature f, + boolean state)+
protected final void _setAnnotations(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderInjector.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderInjector.html new file mode 100644 index 00000000..3d73e9ea --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderInjector.html @@ -0,0 +1,329 @@ + + + + + + +public class ObjectReaderInjector +extends Object+
ObjectReaderModifier
) that can be used to
+ reconfigure ObjectReader
+ that JAX-RS Resource will use for reading input into Java Objects.
+ Usually this class is accessed from a Servlet or JAX-RS filter
+ before execution reaches resource.Modifier and Type | +Field and Description | +
---|---|
protected static AtomicBoolean |
+_hasBeenSet
+Simple marker used to optimize out
+ThreadLocal access in cases
+ where this feature is not being used |
+
protected static ThreadLocal<ObjectReaderModifier> |
+_threadLocal |
+
Modifier and Type | +Method and Description | +
---|---|
static ObjectReaderModifier |
+get() |
+
static ObjectReaderModifier |
+getAndClear() |
+
static void |
+set(ObjectReaderModifier mod) |
+
protected static final ThreadLocal<ObjectReaderModifier> _threadLocal+
protected static final AtomicBoolean _hasBeenSet+
ThreadLocal
access in cases
+ where this feature is not being usedpublic static void set(ObjectReaderModifier mod)+
public static ObjectReaderModifier get()+
public static ObjectReaderModifier getAndClear()+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderModifier.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderModifier.html new file mode 100644 index 00000000..aac27a76 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectReaderModifier.html @@ -0,0 +1,301 @@ + + + + + + +public abstract class ObjectReaderModifier +extends Object+
Constructor and Description | +
---|
ObjectReaderModifier() |
+
Modifier and Type | +Method and Description | +
---|---|
abstract com.fasterxml.jackson.databind.ObjectReader |
+modify(EndpointConfigBase<?> endpoint,
+ javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
+ com.fasterxml.jackson.databind.JavaType resultType,
+ com.fasterxml.jackson.databind.ObjectReader r,
+ com.fasterxml.jackson.core.JsonParser p)
+Method called to let modifier make any changes it wants to to objects
+ used for reading request objects for specified endpoint.
+ |
+
public abstract com.fasterxml.jackson.databind.ObjectReader modify(EndpointConfigBase<?> endpoint, + javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders, + com.fasterxml.jackson.databind.JavaType resultType, + com.fasterxml.jackson.databind.ObjectReader r, + com.fasterxml.jackson.core.JsonParser p) + throws IOException+
endpoint
- End point for which reader is usedhttpHeaders
- HTTP headers sent with request (read-only)resultType
- Type that input is to be bound tor
- ObjectReader as constructed for endpoint, type to handlep
- Parser to use for reading contentIOException
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterInjector.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterInjector.html new file mode 100644 index 00000000..46ed377d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterInjector.html @@ -0,0 +1,326 @@ + + + + + + +public class ObjectWriterInjector +extends Object+
ObjectWriter
+ that JAX-RS Resource will use; usually this is done from a Servlet or JAX-RS filter
+ before execution reaches resource.Modifier and Type | +Field and Description | +
---|---|
protected static AtomicBoolean |
+_hasBeenSet
+Simple marker used to optimize out
+ThreadLocal access in cases
+ where this feature is not being used |
+
protected static ThreadLocal<ObjectWriterModifier> |
+_threadLocal |
+
Modifier and Type | +Method and Description | +
---|---|
static ObjectWriterModifier |
+get() |
+
static ObjectWriterModifier |
+getAndClear() |
+
static void |
+set(ObjectWriterModifier mod) |
+
protected static final ThreadLocal<ObjectWriterModifier> _threadLocal+
protected static final AtomicBoolean _hasBeenSet+
ThreadLocal
access in cases
+ where this feature is not being usedpublic static void set(ObjectWriterModifier mod)+
public static ObjectWriterModifier get()+
public static ObjectWriterModifier getAndClear()+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterModifier.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterModifier.html new file mode 100644 index 00000000..10d4c6b3 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/ObjectWriterModifier.html @@ -0,0 +1,297 @@ + + + + + + +public abstract class ObjectWriterModifier +extends Object+
Constructor and Description | +
---|
ObjectWriterModifier() |
+
Modifier and Type | +Method and Description | +
---|---|
abstract com.fasterxml.jackson.databind.ObjectWriter |
+modify(EndpointConfigBase<?> endpoint,
+ javax.ws.rs.core.MultivaluedMap<String,Object> responseHeaders,
+ Object valueToWrite,
+ com.fasterxml.jackson.databind.ObjectWriter w,
+ com.fasterxml.jackson.core.JsonGenerator g)
+Method called to let modifier make any changes it wants to to objects
+ used for writing response for specified endpoint.
+ |
+
public abstract com.fasterxml.jackson.databind.ObjectWriter modify(EndpointConfigBase<?> endpoint, + javax.ws.rs.core.MultivaluedMap<String,Object> responseHeaders, + Object valueToWrite, + com.fasterxml.jackson.databind.ObjectWriter w, + com.fasterxml.jackson.core.JsonGenerator g) + throws IOException+
responseHeaders
- HTTP headers being returned with response (mutable)IOException
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/AnnotationBundleKey.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/AnnotationBundleKey.html new file mode 100644 index 00000000..97fee9c9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/AnnotationBundleKey.html @@ -0,0 +1,199 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cfg | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+ProviderBase._readers
+Cache for resolved endpoint configurations when reading JSON data
+ |
+
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+ProviderBase._writers
+Cache for resolved endpoint configurations when writing JSON data
+ |
+
Modifier and Type | +Method and Description | +
---|---|
AnnotationBundleKey |
+AnnotationBundleKey.immutableKey()
+Method called to create a safe immutable copy of the key; used when
+ adding entry with this key -- lookups are ok without calling the method.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/Annotations.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/Annotations.html new file mode 100644 index 00000000..e1e81a69 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/Annotations.html @@ -0,0 +1,694 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.cfg | ++ |
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Method and Description | +
---|---|
void |
+ProviderBase.setAnnotationsToUse(Annotations[] annotationsToUse)
+Method for configuring which annotation sets to use (including none).
+ |
+
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+JacksonCBORProvider.BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static Annotations[] |
+JacksonJaxbCBORProvider.DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+CBORMapperConfigurator._resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+CBORMapperConfigurator._resolveIntrospectors(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
CBORMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
JacksonCBORProvider(Annotations... annotationsToUse) |
+
JacksonCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JacksonJaxbCBORProvider(Annotations... annotationsToUse) |
+
JacksonJaxbCBORProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Field and Description | +
---|---|
protected Annotations[] |
+MapperConfiguratorBase._defaultAnnotationsToUse
+Annotations set to use by default; overridden by explicit call
+ to
+MapperConfiguratorBase.setAnnotationsToUse(com.fasterxml.jackson.jaxrs.cfg.Annotations[]) |
+
Modifier and Type | +Method and Description | +
---|---|
static Annotations |
+Annotations.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static Annotations[] |
+Annotations.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected abstract com.fasterxml.jackson.databind.AnnotationIntrospector |
+MapperConfiguratorBase._resolveIntrospectors(Annotations[] annotationsToUse) |
+
protected void |
+MapperConfiguratorBase._setAnnotations(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse) |
+
void |
+MapperConfiguratorBase.setAnnotationsToUse(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
MapperConfiguratorBase(MAPPER mapper,
+ Annotations[] defaultAnnotations) |
+
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+JacksonJsonProvider.BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static Annotations[] |
+JacksonJaxbJsonProvider.DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+JsonMapperConfigurator._resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+JsonMapperConfigurator._resolveIntrospectors(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
JacksonJaxbJsonProvider(Annotations... annotationsToUse) |
+
JacksonJaxbJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JacksonJsonProvider(Annotations... annotationsToUse) |
+
JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JsonMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+JacksonSmileProvider.BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static Annotations[] |
+JacksonJaxbSmileProvider.DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+SmileMapperConfigurator._resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+SmileMapperConfigurator._resolveIntrospectors(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
JacksonJaxbSmileProvider(Annotations... annotationsToUse) |
+
JacksonJaxbSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JacksonSmileProvider(Annotations... annotationsToUse) |
+
JacksonSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
SmileMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+JacksonXMLProvider.BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static Annotations[] |
+JacksonJaxbXMLProvider.DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+XMLMapperConfigurator._resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+XMLMapperConfigurator._resolveIntrospectors(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
JacksonJaxbXMLProvider(Annotations... annotationsToUse) |
+
JacksonJaxbXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JacksonXMLProvider(Annotations... annotationsToUse) |
+
JacksonXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
XMLMapperConfigurator(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+JacksonYAMLProvider.BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static Annotations[] |
+JacksonJaxbYAMLProvider.DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+YAMLMapperConfigurator._resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+YAMLMapperConfigurator._resolveIntrospectors(Annotations[] annotationsToUse) |
+
Constructor and Description | +
---|
JacksonJaxbYAMLProvider(Annotations... annotationsToUse) |
+
JacksonJaxbYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
JacksonYAMLProvider(Annotations... annotationsToUse) |
+
JacksonYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
YAMLMapperConfigurator(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] defAnnotations) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/EndpointConfigBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/EndpointConfigBase.html new file mode 100644 index 00000000..2ac486c3 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/EndpointConfigBase.html @@ -0,0 +1,367 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.cfg | ++ |
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+ProviderBase<THIS extends ProviderBase<THIS,MAPPER,EP_CONFIG,MAPPER_CONFIG>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>,MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER>> |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+CBOREndpointConfig
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+EndpointConfigBase<THIS extends EndpointConfigBase<THIS>>
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
abstract com.fasterxml.jackson.databind.ObjectWriter |
+ObjectWriterModifier.modify(EndpointConfigBase<?> endpoint,
+ javax.ws.rs.core.MultivaluedMap<String,Object> responseHeaders,
+ Object valueToWrite,
+ com.fasterxml.jackson.databind.ObjectWriter w,
+ com.fasterxml.jackson.core.JsonGenerator g)
+Method called to let modifier make any changes it wants to to objects
+ used for writing response for specified endpoint.
+ |
+
abstract com.fasterxml.jackson.databind.ObjectReader |
+ObjectReaderModifier.modify(EndpointConfigBase<?> endpoint,
+ javax.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
+ com.fasterxml.jackson.databind.JavaType resultType,
+ com.fasterxml.jackson.databind.ObjectReader r,
+ com.fasterxml.jackson.core.JsonParser p)
+Method called to let modifier make any changes it wants to to objects
+ used for reading request objects for specified endpoint.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JsonEndpointConfig
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+SmileEndpointConfig
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+XMLEndpointConfig
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+YAMLEndpointConfig
+Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/JaxRSFeature.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/JaxRSFeature.html new file mode 100644 index 00000000..d95ef079 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/JaxRSFeature.html @@ -0,0 +1,230 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cfg | ++ |
Modifier and Type | +Method and Description | +
---|---|
THIS |
+ProviderBase.configure(JaxRSFeature feature,
+ boolean state) |
+
THIS |
+ProviderBase.disable(JaxRSFeature feature) |
+
THIS |
+ProviderBase.disable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
THIS |
+ProviderBase.disable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
THIS |
+ProviderBase.enable(JaxRSFeature feature) |
+
THIS |
+ProviderBase.enable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
THIS |
+ProviderBase.enable(JaxRSFeature first,
+ JaxRSFeature... f2) |
+
boolean |
+ProviderBase.isEnabled(JaxRSFeature f) |
+
Modifier and Type | +Method and Description | +
---|---|
static JaxRSFeature |
+JaxRSFeature.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static JaxRSFeature[] |
+JaxRSFeature.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/MapperConfiguratorBase.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/MapperConfiguratorBase.html new file mode 100644 index 00000000..236dd8d9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/MapperConfiguratorBase.html @@ -0,0 +1,358 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.cfg | ++ |
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+ProviderBase<THIS extends ProviderBase<THIS,MAPPER,EP_CONFIG,MAPPER_CONFIG>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper,EP_CONFIG extends EndpointConfigBase<EP_CONFIG>,MAPPER_CONFIG extends MapperConfiguratorBase<MAPPER_CONFIG,MAPPER>> |
+
Modifier and Type | +Field and Description | +
---|---|
protected MAPPER_CONFIG |
+ProviderBase._mapperConfig
+Helper object used for encapsulating configuration aspects
+ of
+ObjectMapper |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+CBORMapperConfigurator
+Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+MapperConfiguratorBase<IMPL extends MapperConfiguratorBase<IMPL,MAPPER>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper>
+Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JsonMapperConfigurator
+Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+SmileMapperConfigurator
+Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+XMLMapperConfigurator
+Helper class used to encapsulate details of configuring an
+
+XmlMapper instance to be used for data binding, as
+ well as accessing it. |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+YAMLMapperConfigurator
+Helper class used to encapsulate details of configuring an
+
+YAMLMapper instance to be used for data binding, as
+ well as accessing it. |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderInjector.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderInjector.html new file mode 100644 index 00000000..08345245 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderInjector.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderModifier.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderModifier.html new file mode 100644 index 00000000..23a36e41 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectReaderModifier.html @@ -0,0 +1,196 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.cfg | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected static ThreadLocal<ObjectReaderModifier> |
+ObjectReaderInjector._threadLocal |
+
Modifier and Type | +Method and Description | +
---|---|
static ObjectReaderModifier |
+ObjectReaderInjector.get() |
+
static ObjectReaderModifier |
+ObjectReaderInjector.getAndClear() |
+
Modifier and Type | +Method and Description | +
---|---|
static void |
+ObjectReaderInjector.set(ObjectReaderModifier mod) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterInjector.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterInjector.html new file mode 100644 index 00000000..f8d22c6a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterInjector.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterModifier.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterModifier.html new file mode 100644 index 00000000..6fd83f9b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/class-use/ObjectWriterModifier.html @@ -0,0 +1,196 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.cfg | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected static ThreadLocal<ObjectWriterModifier> |
+ObjectWriterInjector._threadLocal |
+
Modifier and Type | +Method and Description | +
---|---|
static ObjectWriterModifier |
+ObjectWriterInjector.get() |
+
static ObjectWriterModifier |
+ObjectWriterInjector.getAndClear() |
+
Modifier and Type | +Method and Description | +
---|---|
static void |
+ObjectWriterInjector.set(ObjectWriterModifier mod) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-frame.html new file mode 100644 index 00000000..740529be --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +Class | +Description | +
---|---|
AnnotationBundleKey | +
+ Helper class used to allow efficient caching of information,
+ given a sequence of Annotations.
+ |
+
EndpointConfigBase<THIS extends EndpointConfigBase<THIS>> | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase<IMPL extends MapperConfiguratorBase<IMPL,MAPPER>,MAPPER extends com.fasterxml.jackson.databind.ObjectMapper> | +
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
ObjectReaderInjector | +
+ Based on ideas from [Issue#32], this class allows registering a
+ modifier (
+ObjectReaderModifier ) that can be used to
+ reconfigure ObjectReader
+ that JAX-RS Resource will use for reading input into Java Objects. |
+
ObjectReaderModifier | ++ |
ObjectWriterInjector | +
+ Based on ideas from [Issue#32], this class allows "overriding" of
+ObjectWriter
+ that JAX-RS Resource will use; usually this is done from a Servlet or JAX-RS filter
+ before execution reaches resource. |
+
ObjectWriterModifier | ++ |
Enum | +Description | +
---|---|
Annotations | +
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
JaxRSFeature | +
+ Enumeration that defines simple on/off features that can be
+ used on all Jackson JAX-RS providers, regardless of
+ underlying data format.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-tree.html new file mode 100644 index 00000000..bcb923d6 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-use.html new file mode 100644 index 00000000..8d96d515 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/cfg/package-use.html @@ -0,0 +1,437 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.cfg | ++ |
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Class and Description | +
---|
AnnotationBundleKey
+ Helper class used to allow efficient caching of information,
+ given a sequence of Annotations.
+ |
+
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
JaxRSFeature
+ Enumeration that defines simple on/off features that can be
+ used on all Jackson JAX-RS providers, regardless of
+ underlying data format.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Class and Description | +
---|
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Class and Description | +
---|
AnnotationBundleKey
+ Helper class used to allow efficient caching of information,
+ given a sequence of Annotations.
+ |
+
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
JaxRSFeature
+ Enumeration that defines simple on/off features that can be
+ used on all Jackson JAX-RS providers, regardless of
+ underlying data format.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
ObjectReaderModifier | +
ObjectWriterModifier | +
Class and Description | +
---|
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Class and Description | +
---|
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Class and Description | +
---|
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Class and Description | +
---|
Annotations
+ Enumeration that defines standard annotation sets available for configuring
+ data binding aspects.
+ |
+
EndpointConfigBase
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
MapperConfiguratorBase
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJaxbJsonProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJaxbJsonProvider.html new file mode 100644 index 00000000..e3903f31 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJaxbJsonProvider.html @@ -0,0 +1,382 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJaxbJsonProvider +extends JacksonJsonProvider+
JacksonJsonProvider
.
++ Typical usage pattern is to just instantiate instance of this + provider for JAX-RS and use as is: this will use both Jackson and + JAXB annotations (with Jackson annotations having priority). +
+ Note: class annotations are duplicated from super class, since it + is not clear whether JAX-RS implementations are required to + check settings of super-classes. It is important to keep annotations + in sync if changed.
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
_jsonpFunctionName, _providers, BASIC_ANNOTATIONS, MIME_JAVASCRIPT, MIME_JAVASCRIPT_MS
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJaxbJsonProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJaxbJsonProvider(Annotations... annotationsToUse) |
+
JacksonJaxbJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
_configForReading, _configForWriting, _locateMapperViaProvider, hasMatchingMediaType, setJSONPFunctionName, version
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] DEFAULT_ANNOTATIONS+
public JacksonJaxbJsonProvider()+
public JacksonJaxbJsonProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJaxbJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJsonProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJsonProvider.html new file mode 100644 index 00000000..f44bf87a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JacksonJsonProvider.html @@ -0,0 +1,618 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJsonProvider +extends ProviderBase<JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>+
MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).
+
+ Actual data binding functionality is implemented by ObjectMapper
:
+ mapper to use can be configured in multiple ways:
+
ProviderBase.setMapper(MAPPER)
+ Provider
that returns ObjectMapper
s.
+
+ Note that the default mapper instance will be automatically created if
+ one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jaxrs.cfg.JaxRSFeature, boolean)
)
+ is called: if so, Provider-based introspection is NOT used, but the
+ resulting Mapper is used as configured.
+
+ Note: version 1.3 added a sub-class (JacksonJaxbJsonProvider
) which
+ is configured by default to use both Jackson and JAXB annotations for configuration
+ (base class when used as-is defaults to using just Jackson annotations)
Modifier and Type | +Field and Description | +
---|---|
protected String |
+_jsonpFunctionName
+JSONP function name to use for automatic JSONP wrapping, if any;
+ if null, no JSONP wrapping is done.
+ |
+
protected javax.ws.rs.ext.Providers |
+_providers
+Injectable context object used to locate configured
+ instance of
+ObjectMapper to use for actual
+ serialization. |
+
static Annotations[] |
+BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
static String |
+MIME_JAVASCRIPT |
+
static String |
+MIME_JAVASCRIPT_MS |
+
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJsonProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJsonProvider(Annotations... annotationsToUse) |
+
JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper) |
+
JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected JsonEndpointConfig |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected JsonEndpointConfig |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Helper method that is called if no mapper has been explicitly configured.
+ |
+
protected boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is supported by this provider.
+ |
+
void |
+setJSONPFunctionName(String fname) |
+
com.fasterxml.jackson.core.Version |
+version()
+Method that will return version information stored in and read from jar
+ that contains this class.
+ |
+
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final String MIME_JAVASCRIPT+
public static final String MIME_JAVASCRIPT_MS+
public static final Annotations[] BASIC_ANNOTATIONS+
protected String _jsonpFunctionName+
@Context +protected javax.ws.rs.ext.Providers _providers+
ObjectMapper
to use for actual
+ serialization.public JacksonJsonProvider()+
public JacksonJsonProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper)+
public JacksonJsonProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
annotationsToUse
- Sets of annotations (Jackson, JAXB) that provider should
+ supportpublic com.fasterxml.jackson.core.Version version()+
public void setJSONPFunctionName(String fname)+
protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
MediaType.getSubtype()
returns "json" or something
+ ending with "+json".
+ Or "text/x-json" (since 2.3)hasMatchingMediaType
in class ProviderBase<JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
protected com.fasterxml.jackson.databind.ObjectMapper _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
ProviderBase
_locateMapperViaProvider
in class ProviderBase<JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
protected JsonEndpointConfig _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
_configForReading
in class ProviderBase<JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
protected JsonEndpointConfig _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
_configForWriting
in class ProviderBase<JacksonJsonProvider,com.fasterxml.jackson.databind.ObjectMapper,JsonEndpointConfig,JsonMapperConfigurator>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonEndpointConfig.html new file mode 100644 index 00000000..ee8d3605 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonEndpointConfig.html @@ -0,0 +1,407 @@ + + + + + + +public class JsonEndpointConfig +extends EndpointConfigBase<JsonEndpointConfig>+
Modifier and Type | +Field and Description | +
---|---|
protected JSONP.Def |
+_jsonp |
+
_activeView, _config, _deserDisable, _deserEnable, _reader, _rootName, _serDisable, _serEnable, _writer
Modifier | +Constructor and Description | +
---|---|
protected |
+JsonEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
protected void |
+addAnnotation(Class<? extends Annotation> type,
+ Annotation annotation,
+ boolean forWriting) |
+
Object |
+applyJSONP(Object value)
+Method that will add JSONP wrapper object, if and as
+ configured by collected annotations.
+ |
+
static JsonEndpointConfig |
+forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static JsonEndpointConfig |
+forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations,
+ String defaultJsonpMethod) |
+
Object |
+modifyBeforeWrite(Object value) |
+
add, getActiveView, getReader, getRootName, getWriter, initReader, initWriter, nullIfEmpty
protected JsonEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
public static JsonEndpointConfig forReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
public static JsonEndpointConfig forWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations, + String defaultJsonpMethod)+
protected void addAnnotation(Class<? extends Annotation> type, + Annotation annotation, + boolean forWriting)+
addAnnotation
in class EndpointConfigBase<JsonEndpointConfig>
public Object modifyBeforeWrite(Object value)+
modifyBeforeWrite
in class EndpointConfigBase<JsonEndpointConfig>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonMapperConfigurator.html new file mode 100644 index 00000000..81bee25d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/JsonMapperConfigurator.html @@ -0,0 +1,383 @@ + + + + + + +public class JsonMapperConfigurator +extends MapperConfiguratorBase<JsonMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>+
ObjectMapper
instance to be used for data binding, as
+ well as accessing it._defaultAnnotationsToUse, _defaultMapper, _jaxbIntrospectorClass, _mapper
Constructor and Description | +
---|
JsonMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getConfiguredMapper()
+Method that locates, configures and returns
+ObjectMapper to use |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getDefaultMapper() |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
_setAnnotations, configure, configure, configure, configure, setAnnotationsToUse, setMapper
public JsonMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] defAnnotations)+
public com.fasterxml.jackson.databind.ObjectMapper getConfiguredMapper()+
ObjectMapper
to usegetConfiguredMapper
in class MapperConfiguratorBase<JsonMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
public com.fasterxml.jackson.databind.ObjectMapper getDefaultMapper()+
getDefaultMapper
in class MapperConfiguratorBase<JsonMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.ObjectMapper mapper()+
mapper
in class MapperConfiguratorBase<JsonMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
_resolveIntrospectors
in class MapperConfiguratorBase<JsonMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospector(Annotations ann)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/PackageVersion.html new file mode 100644 index 00000000..c3662ba6 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/PackageVersion.html @@ -0,0 +1,321 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.Def.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.Def.html new file mode 100644 index 00000000..5abf23a5 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.Def.html @@ -0,0 +1,319 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.html new file mode 100644 index 00000000..59d9e8ed --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/JSONP.html @@ -0,0 +1,274 @@ + + + + + + +@Target(value={ANNOTATION_TYPE,METHOD}) + @Retention(value=RUNTIME) +public @interface JSONP+
Modifier and Type | +Optional Element and Description | +
---|---|
String |
+prefix
+Prefix String used for JSONP if not empty: will be included
+ verbatim before JSON value.
+ |
+
String |
+suffix
+Suffix String used for JSONP if not empty: will be included
+ verbatim after JSON value.
+ |
+
String |
+value
+
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.Def.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.Def.html new file mode 100644 index 00000000..2e66f8a8 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.Def.html @@ -0,0 +1,170 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
Modifier and Type | +Field and Description | +
---|---|
protected JSONP.Def |
+JsonEndpointConfig._jsonp |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.html new file mode 100644 index 00000000..b347b947 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/class-use/JSONP.html @@ -0,0 +1,166 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json.annotation | +
+ Package that contains annotations specific to JSON dataformat.
+ |
+
Constructor and Description | +
---|
Def(JSONP json) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-frame.html new file mode 100644 index 00000000..43f1a09d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
JSONP.Def | +
+ Helper class for encapsulating information from
+JSONP
+ annotation instance. |
+
Annotation Type | +Description | +
---|---|
JSONP | ++ |
+ NOTE: starting with version 2.2, general-purpose annotations + will be moved to a shared package, and this package will only + contains JSON-specific annotations.
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-tree.html new file mode 100644 index 00000000..b9a2dc0b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-tree.html @@ -0,0 +1,143 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-use.html new file mode 100644 index 00000000..c73c8a84 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/annotation/package-use.html @@ -0,0 +1,187 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.json.annotation | +
+ Package that contains annotations specific to JSON dataformat.
+ |
+
Class and Description | +
---|
JSONP.Def
+ Helper class for encapsulating information from
+JSONP
+ annotation instance. |
+
Class and Description | +
---|
JSONP | +
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJaxbJsonProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJaxbJsonProvider.html new file mode 100644 index 00000000..f99d33ce --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJaxbJsonProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJsonProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJsonProvider.html new file mode 100644 index 00000000..4caf81aa --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JacksonJsonProvider.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbJsonProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonEndpointConfig.html new file mode 100644 index 00000000..921c8051 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonEndpointConfig.html @@ -0,0 +1,187 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected JsonEndpointConfig |
+JacksonJsonProvider._configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected JsonEndpointConfig |
+JacksonJsonProvider._configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
static JsonEndpointConfig |
+JsonEndpointConfig.forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static JsonEndpointConfig |
+JsonEndpointConfig.forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations,
+ String defaultJsonpMethod) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonMapperConfigurator.html new file mode 100644 index 00000000..7e5b47a1 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/JsonMapperConfigurator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/PackageVersion.html new file mode 100644 index 00000000..76de2677 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-frame.html new file mode 100644 index 00000000..bd3a7dab --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
JacksonJaxbJsonProvider | +
+ JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
JacksonJsonProvider | +
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
JsonEndpointConfig | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
JsonMapperConfigurator | +
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in
+ pom.xml.
+ |
+
+ Also continues supporting functionality, such as + exception mappers that can simplify handling of + error conditions. +
+ There are two default provider classes: +
JacksonJsonProvider
is the basic
+ provider configured to use Jackson annotations
+ JacksonJaxbJsonProvider
is extension
+ of the basic provider, configured to additionally use JAXB annotations,
+ in addition to (or in addition of, if so configured) Jackson annotations.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-tree.html new file mode 100644 index 00000000..fe8db419 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-use.html new file mode 100644 index 00000000..392e007b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/json/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
Class and Description | +
---|
JacksonJsonProvider
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
JsonEndpointConfig
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonJaxbSmileProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonJaxbSmileProvider.html new file mode 100644 index 00000000..e0784262 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonJaxbSmileProvider.html @@ -0,0 +1,382 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJaxbSmileProvider +extends JacksonSmileProvider+
JacksonSmileProvider
.
++ Typical usage pattern is to just instantiate instance of this + provider for JAX-RS and use as is: this will use both Jackson and + JAXB annotations (with Jackson annotations having priority). +
+ Note: class annotations are duplicated from super class, since it + is not clear whether JAX-RS implementations are required to + check settings of super-classes. It is important to keep annotations + in sync if changed.
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
_providers, BASIC_ANNOTATIONS
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJaxbSmileProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJaxbSmileProvider(Annotations... annotationsToUse) |
+
JacksonJaxbSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
_configForReading, _configForWriting, _locateMapperViaProvider, hasMatchingMediaType, version
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] DEFAULT_ANNOTATIONS+
public JacksonJaxbSmileProvider()+
public JacksonJaxbSmileProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJaxbSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonSmileProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonSmileProvider.html new file mode 100644 index 00000000..0275a400 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/JacksonSmileProvider.html @@ -0,0 +1,565 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonSmileProvider +extends ProviderBase<JacksonSmileProvider,com.fasterxml.jackson.databind.ObjectMapper,SmileEndpointConfig,SmileMapperConfigurator>+
MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s).
+
+ Actual data binding functionality is implemented by ObjectMapper
:
+ mapper to use can be configured in multiple ways:
+
ProviderBase.setMapper(MAPPER)
+ Provider
that returns ObjectMapper
s.
+
+ Note that the default mapper instance will be automatically created if
+ one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jaxrs.cfg.JaxRSFeature, boolean)
)
+ is called: if so, Provider-based introspection is NOT used, but the
+ resulting Mapper is used as configured.
+
+ Note that there is also a sub-class -- (JacksonJaxbSmileProvider
) -- that
+ is configured by default to use both Jackson and JAXB annotations for configuration
+ (base class when used as-is defaults to using just Jackson annotations)
Modifier and Type | +Field and Description | +
---|---|
protected javax.ws.rs.ext.Providers |
+_providers
+Injectable context object used to locate configured
+ instance of
+ObjectMapper to use for actual
+ serialization. |
+
static Annotations[] |
+BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonSmileProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonSmileProvider(Annotations... annotationsToUse) |
+
JacksonSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper) |
+
JacksonSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected SmileEndpointConfig |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected SmileEndpointConfig |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Method called to locate
+ObjectMapper to use for serialization
+ and deserialization. |
+
protected boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is Smile type or sub type.
+ |
+
com.fasterxml.jackson.core.Version |
+version()
+Method that will return version information stored in and read from jar
+ that contains this class.
+ |
+
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _createParser, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] BASIC_ANNOTATIONS+
@Context +protected javax.ws.rs.ext.Providers _providers+
ObjectMapper
to use for actual
+ serialization.public JacksonSmileProvider()+
public JacksonSmileProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper)+
public JacksonSmileProvider(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] annotationsToUse)+
annotationsToUse
- Sets of annotations (Jackson, JAXB) that provider should
+ supportpublic com.fasterxml.jackson.core.Version version()+
protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
MediaType.getSubtype()
returns
+ "smile" or something ending with "+smile".hasMatchingMediaType
in class ProviderBase<JacksonSmileProvider,com.fasterxml.jackson.databind.ObjectMapper,SmileEndpointConfig,SmileMapperConfigurator>
protected com.fasterxml.jackson.databind.ObjectMapper _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
ObjectMapper
to use for serialization
+ and deserialization. If an instance has been explicitly defined by
+ ProviderBase.setMapper(MAPPER)
(or non-null instance passed in constructor), that
+ will be used.
+ If not, will try to locate it using standard JAX-RS
+ ContextResolver
mechanism, if it has been properly configured
+ to access it (by JAX-RS runtime).
+ Finally, if no mapper is found, will return a default unconfigured
+ ObjectMapper
instance (one constructed with default constructor
+ and not modified in any way)_locateMapperViaProvider
in class ProviderBase<JacksonSmileProvider,com.fasterxml.jackson.databind.ObjectMapper,SmileEndpointConfig,SmileMapperConfigurator>
type
- Class of object being serialized or deserialized;
+ not checked at this point, since it is assumed that unprocessable
+ classes have been already weeded out,
+ but will be passed to ContextResolver
as is.mediaType
- Declared media type for the instance to process:
+ not used by this method,
+ but will be passed to ContextResolver
as is.protected SmileEndpointConfig _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
_configForReading
in class ProviderBase<JacksonSmileProvider,com.fasterxml.jackson.databind.ObjectMapper,SmileEndpointConfig,SmileMapperConfigurator>
protected SmileEndpointConfig _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
_configForWriting
in class ProviderBase<JacksonSmileProvider,com.fasterxml.jackson.databind.ObjectMapper,SmileEndpointConfig,SmileMapperConfigurator>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/PackageVersion.html new file mode 100644 index 00000000..dd51ec40 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/PackageVersion.html @@ -0,0 +1,321 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileEndpointConfig.html new file mode 100644 index 00000000..16e2a960 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileEndpointConfig.html @@ -0,0 +1,338 @@ + + + + + + +public class SmileEndpointConfig +extends EndpointConfigBase<SmileEndpointConfig>+
_activeView, _config, _deserDisable, _deserEnable, _reader, _rootName, _serDisable, _serEnable, _writer
Modifier | +Constructor and Description | +
---|---|
protected |
+SmileEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
static SmileEndpointConfig |
+forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static SmileEndpointConfig |
+forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Object |
+modifyBeforeWrite(Object value) |
+
add, addAnnotation, getActiveView, getReader, getRootName, getWriter, initReader, initWriter, nullIfEmpty
protected SmileEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
public static SmileEndpointConfig forReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
public static SmileEndpointConfig forWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
public Object modifyBeforeWrite(Object value)+
modifyBeforeWrite
in class EndpointConfigBase<SmileEndpointConfig>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMapperConfigurator.html new file mode 100644 index 00000000..be2a38c7 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMapperConfigurator.html @@ -0,0 +1,383 @@ + + + + + + +public class SmileMapperConfigurator +extends MapperConfiguratorBase<SmileMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>+
ObjectMapper
instance to be used for data binding, as
+ well as accessing it._defaultAnnotationsToUse, _defaultMapper, _jaxbIntrospectorClass, _mapper
Constructor and Description | +
---|
SmileMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getConfiguredMapper()
+Method that locates, configures and returns
+ObjectMapper to use |
+
com.fasterxml.jackson.databind.ObjectMapper |
+getDefaultMapper() |
+
protected com.fasterxml.jackson.databind.ObjectMapper |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
_setAnnotations, configure, configure, configure, configure, setAnnotationsToUse, setMapper
public SmileMapperConfigurator(com.fasterxml.jackson.databind.ObjectMapper mapper, + Annotations[] defAnnotations)+
public com.fasterxml.jackson.databind.ObjectMapper getConfiguredMapper()+
ObjectMapper
to usegetConfiguredMapper
in class MapperConfiguratorBase<SmileMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
public com.fasterxml.jackson.databind.ObjectMapper getDefaultMapper()+
getDefaultMapper
in class MapperConfiguratorBase<SmileMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.ObjectMapper mapper()+
mapper
in class MapperConfiguratorBase<SmileMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
_resolveIntrospectors
in class MapperConfiguratorBase<SmileMapperConfigurator,com.fasterxml.jackson.databind.ObjectMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospector(Annotations ann)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMediaTypes.html new file mode 100644 index 00000000..e9058f4b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/SmileMediaTypes.html @@ -0,0 +1,292 @@ + + + + + + +public class SmileMediaTypes +extends Object+
Modifier and Type | +Field and Description | +
---|---|
static String |
+APPLICATION_JACKSON_SMILE |
+
static javax.ws.rs.core.MediaType |
+APPLICATION_JACKSON_SMILE_TYPE |
+
Constructor and Description | +
---|
SmileMediaTypes() |
+
public static final String APPLICATION_JACKSON_SMILE+
public static final javax.ws.rs.core.MediaType APPLICATION_JACKSON_SMILE_TYPE+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonJaxbSmileProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonJaxbSmileProvider.html new file mode 100644 index 00000000..65ddd570 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonJaxbSmileProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonSmileProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonSmileProvider.html new file mode 100644 index 00000000..c03179ee --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/JacksonSmileProvider.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbSmileProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/PackageVersion.html new file mode 100644 index 00000000..73b9d9c8 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileEndpointConfig.html new file mode 100644 index 00000000..7b61ae73 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileEndpointConfig.html @@ -0,0 +1,186 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected SmileEndpointConfig |
+JacksonSmileProvider._configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected SmileEndpointConfig |
+JacksonSmileProvider._configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
static SmileEndpointConfig |
+SmileEndpointConfig.forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static SmileEndpointConfig |
+SmileEndpointConfig.forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMapperConfigurator.html new file mode 100644 index 00000000..30bdd28a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMapperConfigurator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMediaTypes.html new file mode 100644 index 00000000..8a13b7c0 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/class-use/SmileMediaTypes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-frame.html new file mode 100644 index 00000000..19e3b738 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
JacksonJaxbSmileProvider | +
+ JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
JacksonSmileProvider | +
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in
+ pom.xml.
+ |
+
SmileEndpointConfig | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
SmileMapperConfigurator | +
+ Helper class used to encapsulate details of configuring an
+
+ObjectMapper instance to be used for data binding, as
+ well as accessing it. |
+
SmileMediaTypes | ++ |
+ Also continues supporting functionality, such as + exception mappers that can simplify handling of + error conditions. +
+ There are two default provider classes: +
JacksonSmileProvider
is the basic
+ provider configured to use Jackson annotations
+ JacksonJaxbSmileProvider
is extension
+ of the basic provider, configured to additionally use JAXB annotations,
+ in addition to (or in addition of, if so configured) Jackson annotations.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-tree.html new file mode 100644 index 00000000..816be8d9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-use.html new file mode 100644 index 00000000..7601e6a2 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/smile/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
Class and Description | +
---|
JacksonSmileProvider
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s). |
+
SmileEndpointConfig
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/ClassKey.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/ClassKey.html new file mode 100644 index 00000000..b3ea0caf --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/ClassKey.html @@ -0,0 +1,373 @@ + + + + + + +public final class ClassKey +extends Object +implements Comparable<ClassKey>+
Class
.
+ The reason for having a separate key class instead of
+ directly using Class
as key is mostly
+ to allow for redefining hashCode
method --
+ for some strange reason, Class
does not
+ redefine Object.hashCode()
and thus uses identity
+ hash, which is pretty slow. This makes key access using
+ Class
unnecessarily slow.
++ Note: since class is not strictly immutable, caller must + know what it is doing, if changing field values.
Constructor and Description | +
---|
ClassKey() |
+
ClassKey(Class<?> clz) |
+
public ClassKey()+
public ClassKey(Class<?> clz)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/EndpointAsBeanProperty.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/EndpointAsBeanProperty.html new file mode 100644 index 00000000..92ff11a7 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/EndpointAsBeanProperty.html @@ -0,0 +1,449 @@ + + + + + + +public class EndpointAsBeanProperty
+extends com.fasterxml.jackson.databind.BeanProperty.Std
+BeanProperty
implementation used for passing annotations
+ from JAX-RS endpoint into Jackson. This tries to imitate behavior
+ one would get if actual resource method was used as POJO property;
+ ideally this would be how implementation works but due JAX-RS API
+ limitations, we are only given annotations associated, and that
+ has to do.
++ NOTE: not yet used by JAX-RS provider, directly, as of Jackson 2.9
com.fasterxml.jackson.databind.BeanProperty.Bogus, com.fasterxml.jackson.databind.BeanProperty.Std
Modifier and Type | +Field and Description | +
---|---|
com.fasterxml.jackson.databind.introspect.AnnotationMap |
+_annotations |
+
protected Annotation[] |
+_rawAnnotations |
+
static com.fasterxml.jackson.databind.PropertyName |
+ENDPOINT_NAME |
+
_member, _metadata, _name, _type, _wrapperName
EMPTY_FORMAT, EMPTY_INCLUDE
Modifier | +Constructor and Description | +
---|---|
protected |
+EndpointAsBeanProperty(EndpointAsBeanProperty base,
+ com.fasterxml.jackson.databind.JavaType newType) |
+
|
+EndpointAsBeanProperty(com.fasterxml.jackson.databind.PropertyName name,
+ com.fasterxml.jackson.databind.JavaType type,
+ Annotation[] annotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.introspect.AnnotationMap |
+annotations() |
+
<A extends Annotation> |
+getAnnotation(Class<A> acls) |
+
com.fasterxml.jackson.databind.BeanProperty.Std |
+withType(com.fasterxml.jackson.databind.JavaType type) |
+
depositSchemaProperty, findAliases, findFormatOverrides, findPropertyFormat, findPropertyInclusion, getContextAnnotation, getFullName, getMember, getMetadata, getName, getType, getWrapperName, isRequired, isVirtual
public static final com.fasterxml.jackson.databind.PropertyName ENDPOINT_NAME+
protected transient Annotation[] _rawAnnotations+
public com.fasterxml.jackson.databind.introspect.AnnotationMap _annotations+
public EndpointAsBeanProperty(com.fasterxml.jackson.databind.PropertyName name, + com.fasterxml.jackson.databind.JavaType type, + Annotation[] annotations)+
protected EndpointAsBeanProperty(EndpointAsBeanProperty base, + com.fasterxml.jackson.databind.JavaType newType)+
public com.fasterxml.jackson.databind.BeanProperty.Std withType(com.fasterxml.jackson.databind.JavaType type)+
withType
in class com.fasterxml.jackson.databind.BeanProperty.Std
public <A extends Annotation> A getAnnotation(Class<A> acls)+
getAnnotation
in interface com.fasterxml.jackson.databind.BeanProperty
getAnnotation
in class com.fasterxml.jackson.databind.BeanProperty.Std
protected com.fasterxml.jackson.databind.introspect.AnnotationMap annotations()+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/LRUMap.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/LRUMap.html new file mode 100644 index 00000000..214b8c44 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/LRUMap.html @@ -0,0 +1,384 @@ + + + + + + +public class LRUMap<K,V> +extends LinkedHashMap<K,V>+
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Modifier and Type | +Field and Description | +
---|---|
protected int |
+_maxEntries |
+
Constructor and Description | +
---|
LRUMap(int initialEntries,
+ int maxEntries) |
+
Modifier and Type | +Method and Description | +
---|---|
protected boolean |
+removeEldestEntry(Map.Entry<K,V> eldest) |
+
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, replaceAll, values
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size
equals, hashCode, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size
public LRUMap(int initialEntries, + int maxEntries)+
protected boolean removeEldestEntry(Map.Entry<K,V> eldest)+
removeEldestEntry
in class LinkedHashMap<K,V>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/ClassKey.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/ClassKey.html new file mode 100644 index 00000000..8a182f02 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/ClassKey.html @@ -0,0 +1,244 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.util | +
+ Miscellaneous helper classes used by providers.
+ |
+
Modifier and Type | +Field and Description | +
---|---|
protected HashMap<ClassKey,Boolean> |
+ProviderBase._cfgCustomUntouchables
+Map that contains overrides to default list of untouchable
+ types:
+true meaning that entry is untouchable,
+ false that is is not. |
+
static HashSet<ClassKey> |
+ProviderBase._untouchables |
+
protected static HashSet<ClassKey> |
+ProviderBase.DEFAULT_UNTOUCHABLES
+Looks like we need to worry about accidental
+ data binding for types we shouldn't be handling.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected boolean |
+ProviderBase._isIgnorableForReading(ClassKey typeKey)
+Overridable helper method called to check whether given type is a known
+ "ignorable type" (in context of reading), values of which are not bound
+ from content.
+ |
+
protected boolean |
+ProviderBase._isIgnorableForWriting(ClassKey typeKey)
+Overridable helper method called to check whether given type is a known
+ "ignorable type" (in context of reading), values of which
+ can not be written out.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected static boolean |
+ProviderBase._containedIn(Class<?> mainType,
+ HashSet<ClassKey> set) |
+
Modifier and Type | +Method and Description | +
---|---|
int |
+ClassKey.compareTo(ClassKey other) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/EndpointAsBeanProperty.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/EndpointAsBeanProperty.html new file mode 100644 index 00000000..b99ef1de --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/EndpointAsBeanProperty.html @@ -0,0 +1,167 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.util | +
+ Miscellaneous helper classes used by providers.
+ |
+
Constructor and Description | +
---|
EndpointAsBeanProperty(EndpointAsBeanProperty base,
+ com.fasterxml.jackson.databind.JavaType newType) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/LRUMap.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/LRUMap.html new file mode 100644 index 00000000..ed3c0f35 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/class-use/LRUMap.html @@ -0,0 +1,174 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
Modifier and Type | +Field and Description | +
---|---|
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+ProviderBase._readers
+Cache for resolved endpoint configurations when reading JSON data
+ |
+
protected LRUMap<AnnotationBundleKey,EP_CONFIG> |
+ProviderBase._writers
+Cache for resolved endpoint configurations when writing JSON data
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-frame.html new file mode 100644 index 00000000..e5c89eeb --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
ClassKey | +
+ Efficient key class, used instead of using
+Class . |
+
EndpointAsBeanProperty | +
+BeanProperty implementation used for passing annotations
+ from JAX-RS endpoint into Jackson. |
+
LRUMap<K,V> | +
+ Helper for simple bounded LRU maps used for reusing lookup values.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-tree.html new file mode 100644 index 00000000..a9062030 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-use.html new file mode 100644 index 00000000..758b0ebb --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/util/package-use.html @@ -0,0 +1,195 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.util | +
+ Miscellaneous helper classes used by providers.
+ |
+
Class and Description | +
---|
ClassKey
+ Efficient key class, used instead of using
+Class . |
+
LRUMap
+ Helper for simple bounded LRU maps used for reusing lookup values.
+ |
+
Class and Description | +
---|
ClassKey
+ Efficient key class, used instead of using
+Class . |
+
EndpointAsBeanProperty
+BeanProperty implementation used for passing annotations
+ from JAX-RS endpoint into Jackson. |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonJaxbXMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonJaxbXMLProvider.html new file mode 100644 index 00000000..7ec8d45c --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonJaxbXMLProvider.html @@ -0,0 +1,382 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJaxbXMLProvider +extends JacksonXMLProvider+
JacksonXMLProvider
.
++ Typical usage pattern is to just instantiate instance of this + provider for JAX-RS and use as is: this will use both Jackson and + JAXB annotations (with Jackson annotations having priority). +
+ Note: class annotations are duplicated from super class, since it + is not clear whether JAX-RS implementations are required to + check settings of super-classes. It is important to keep annotations + in sync if changed.
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
_providers, BASIC_ANNOTATIONS
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJaxbXMLProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJaxbXMLProvider(Annotations... annotationsToUse) |
+
JacksonJaxbXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
_configForReading, _configForWriting, _createParser, _locateMapperViaProvider, hasMatchingMediaType, version
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] DEFAULT_ANNOTATIONS+
public JacksonJaxbXMLProvider()+
public JacksonJaxbXMLProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJaxbXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonXMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonXMLProvider.html new file mode 100644 index 00000000..41072d53 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/JacksonXMLProvider.html @@ -0,0 +1,595 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonXMLProvider +extends ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>+
MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).
+
+ Actual data binding functionality is implemented by ObjectMapper
:
+ mapper to use can be configured in multiple ways:
+
ProviderBase.setMapper(MAPPER)
+ Provider
that returns XmlMapper
s.
+
+ Note that the default mapper instance will be automatically created if
+ one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jaxrs.cfg.JaxRSFeature, boolean)
)
+ is called: if so, Provider-based introspection is NOT used, but the
+ resulting Mapper is used as configured.
+
+ Note that there is also a sub-class -- (JacksonJaxbXMLProvider
) -- that
+ is configured by default to use both Jackson and JAXB annotations for configuration
+ (base class when used as-is defaults to using just Jackson annotations)
Modifier and Type | +Field and Description | +
---|---|
protected javax.ws.rs.ext.Providers |
+_providers
+Injectable context object used to locate configured
+ instance of
+XmlMapper to use for actual
+ serialization. |
+
static Annotations[] |
+BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonXMLProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonXMLProvider(Annotations... annotationsToUse) |
+
JacksonXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper) |
+
JacksonXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected XMLEndpointConfig |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected XMLEndpointConfig |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected com.fasterxml.jackson.core.JsonParser |
+_createParser(com.fasterxml.jackson.databind.ObjectReader reader,
+ InputStream rawStream)
+Overridable helper method called to create a
+JsonParser for reading
+ contents of given raw InputStream . |
+
com.fasterxml.jackson.dataformat.xml.XmlMapper |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Method called to locate
+XmlMapper to use for serialization
+ and deserialization. |
+
protected boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is XML type or sub type.
+ |
+
com.fasterxml.jackson.core.Version |
+version()
+Method that will return version information stored in and read from jar
+ that contains this class.
+ |
+
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] BASIC_ANNOTATIONS+
@Context +protected javax.ws.rs.ext.Providers _providers+
XmlMapper
to use for actual
+ serialization.public JacksonXMLProvider()+
public JacksonXMLProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper)+
public JacksonXMLProvider(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, + Annotations[] annotationsToUse)+
annotationsToUse
- Sets of annotations (Jackson, JAXB) that provider should
+ supportpublic com.fasterxml.jackson.core.Version version()+
protected XMLEndpointConfig _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
_configForReading
in class ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>
protected XMLEndpointConfig _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
_configForWriting
in class ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>
protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
MediaType.getSubtype()
returns "xml" or something
+ ending with "+xml".hasMatchingMediaType
in class ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>
public com.fasterxml.jackson.dataformat.xml.XmlMapper _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
XmlMapper
to use for serialization
+ and deserialization. If an instance has been explicitly defined by
+ ProviderBase.setMapper(MAPPER)
(or non-null instance passed in constructor), that
+ will be used.
+ If not, will try to locate it using standard JAX-RS
+ ContextResolver
mechanism, if it has been properly configured
+ to access it (by JAX-RS runtime).
+ Finally, if no mapper is found, will return a default unconfigured
+ ObjectMapper
instance (one constructed with default constructor
+ and not modified in any way)_locateMapperViaProvider
in class ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>
type
- Class of object being serialized or deserialized;
+ not checked at this point, since it is assumed that unprocessable
+ classes have been already weeded out,
+ but will be passed to ContextResolver
as is.mediaType
- Declared media type for the instance to process:
+ not used by this method,
+ but will be passed to ContextResolver
as is.protected com.fasterxml.jackson.core.JsonParser _createParser(com.fasterxml.jackson.databind.ObjectReader reader, + InputStream rawStream) + throws IOException+
ProviderBase
JsonParser
for reading
+ contents of given raw InputStream
.
+ May return null to indicate that Stream is empty; that is, contains no
+ content._createParser
in class ProviderBase<JacksonXMLProvider,com.fasterxml.jackson.dataformat.xml.XmlMapper,XMLEndpointConfig,XMLMapperConfigurator>
IOException
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/PackageVersion.html new file mode 100644 index 00000000..8416899d --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/PackageVersion.html @@ -0,0 +1,321 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLEndpointConfig.html new file mode 100644 index 00000000..61df6109 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLEndpointConfig.html @@ -0,0 +1,338 @@ + + + + + + +public class XMLEndpointConfig +extends EndpointConfigBase<XMLEndpointConfig>+
_activeView, _config, _deserDisable, _deserEnable, _reader, _rootName, _serDisable, _serEnable, _writer
Modifier | +Constructor and Description | +
---|---|
protected |
+XMLEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
static XMLEndpointConfig |
+forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static XMLEndpointConfig |
+forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Object |
+modifyBeforeWrite(Object value) |
+
add, addAnnotation, getActiveView, getReader, getRootName, getWriter, initReader, initWriter, nullIfEmpty
protected XMLEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
public static XMLEndpointConfig forReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
public static XMLEndpointConfig forWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
public Object modifyBeforeWrite(Object value)+
modifyBeforeWrite
in class EndpointConfigBase<XMLEndpointConfig>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLMapperConfigurator.html new file mode 100644 index 00000000..7cd8e598 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/XMLMapperConfigurator.html @@ -0,0 +1,396 @@ + + + + + + +public class XMLMapperConfigurator +extends MapperConfiguratorBase<XMLMapperConfigurator,com.fasterxml.jackson.dataformat.xml.XmlMapper>+
XmlMapper
instance to be used for data binding, as
+ well as accessing it._defaultAnnotationsToUse, _defaultMapper, _jaxbIntrospectorClass, _mapper
Constructor and Description | +
---|
XMLMapperConfigurator(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
com.fasterxml.jackson.dataformat.xml.XmlMapper |
+getConfiguredMapper()
+Method that locates, configures and returns
+XmlMapper to use |
+
protected com.fasterxml.jackson.dataformat.xml.JacksonXmlModule |
+getConfiguredModule() |
+
com.fasterxml.jackson.dataformat.xml.XmlMapper |
+getDefaultMapper() |
+
protected com.fasterxml.jackson.dataformat.xml.XmlMapper |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
_setAnnotations, configure, configure, configure, configure, setAnnotationsToUse, setMapper
public XMLMapperConfigurator(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, + Annotations[] defAnnotations)+
public com.fasterxml.jackson.dataformat.xml.XmlMapper getConfiguredMapper()+
XmlMapper
to usegetConfiguredMapper
in class MapperConfiguratorBase<XMLMapperConfigurator,com.fasterxml.jackson.dataformat.xml.XmlMapper>
public com.fasterxml.jackson.dataformat.xml.XmlMapper getDefaultMapper()+
getDefaultMapper
in class MapperConfiguratorBase<XMLMapperConfigurator,com.fasterxml.jackson.dataformat.xml.XmlMapper>
protected com.fasterxml.jackson.dataformat.xml.JacksonXmlModule getConfiguredModule()+
protected com.fasterxml.jackson.dataformat.xml.XmlMapper mapper()+
mapper
in class MapperConfiguratorBase<XMLMapperConfigurator,com.fasterxml.jackson.dataformat.xml.XmlMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
_resolveIntrospectors
in class MapperConfiguratorBase<XMLMapperConfigurator,com.fasterxml.jackson.dataformat.xml.XmlMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospector(Annotations ann)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonJaxbXMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonJaxbXMLProvider.html new file mode 100644 index 00000000..1e1eeecc --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonJaxbXMLProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonXMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonXMLProvider.html new file mode 100644 index 00000000..0ff10ede --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/JacksonXMLProvider.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbXMLProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/PackageVersion.html new file mode 100644 index 00000000..694a8de2 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLEndpointConfig.html new file mode 100644 index 00000000..51db5105 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLEndpointConfig.html @@ -0,0 +1,186 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected XMLEndpointConfig |
+JacksonXMLProvider._configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected XMLEndpointConfig |
+JacksonXMLProvider._configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
static XMLEndpointConfig |
+XMLEndpointConfig.forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static XMLEndpointConfig |
+XMLEndpointConfig.forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLMapperConfigurator.html new file mode 100644 index 00000000..c028ee7b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/class-use/XMLMapperConfigurator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-frame.html new file mode 100644 index 00000000..be2f3981 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
JacksonJaxbXMLProvider | +
+ JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
JacksonXMLProvider | +
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in
+ pom.xml.
+ |
+
XMLEndpointConfig | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
XMLMapperConfigurator | +
+ Helper class used to encapsulate details of configuring an
+
+XmlMapper instance to be used for data binding, as
+ well as accessing it. |
+
+ Also continues supporting functionality, such as + exception mappers that can simplify handling of + error conditions. +
+ There are two default provider classes: +
JacksonXMLProvider
is the basic
+ provider configured to use Jackson annotations
+ JacksonJaxbXMLProvider
is extension
+ of the basic provider, configured to additionally use JAXB annotations,
+ in addition to (or in addition of, if so configured) Jackson annotations.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-tree.html new file mode 100644 index 00000000..3cc252e4 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-use.html new file mode 100644 index 00000000..e5e7101e --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/xml/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
Class and Description | +
---|
JacksonXMLProvider
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
XMLEndpointConfig
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonJaxbYAMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonJaxbYAMLProvider.html new file mode 100644 index 00000000..0777980f --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonJaxbYAMLProvider.html @@ -0,0 +1,382 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonJaxbYAMLProvider +extends JacksonYAMLProvider+
JacksonYAMLProvider
.
++ Typical usage pattern is to just instantiate instance of this + provider for JAX-RS and use as is: this will use both Jackson and + JAXB annotations (with Jackson annotations having priority). +
+ Note: class annotations are duplicated from super class, since it + is not clear whether JAX-RS implementations are required to + check settings of super-classes. It is important to keep annotations + in sync if changed.
Modifier and Type | +Field and Description | +
---|---|
static Annotations[] |
+DEFAULT_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: use Jackson annotations if found; if not, use
+ JAXB annotations as fallback.
+ |
+
_providers, BASIC_ANNOTATIONS
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonJaxbYAMLProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonJaxbYAMLProvider(Annotations... annotationsToUse) |
+
JacksonJaxbYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
_configForReading, _configForWriting, _createParser, _locateMapperViaProvider, hasMatchingMediaType, version
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] DEFAULT_ANNOTATIONS+
public JacksonJaxbYAMLProvider()+
public JacksonJaxbYAMLProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonJaxbYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper, + Annotations[] annotationsToUse)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonYAMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonYAMLProvider.html new file mode 100644 index 00000000..b70253e8 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/JacksonYAMLProvider.html @@ -0,0 +1,595 @@ + + + + + + +@Provider + @Consumes(value="*/*") + @Produces(value="*/*") +public class JacksonYAMLProvider +extends ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>+
MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).
+
+ Actual data binding functionality is implemented by ObjectMapper
:
+ mapper to use can be configured in multiple ways:
+
ProviderBase.setMapper(MAPPER)
+ Provider
that returns YAMLMapper
s.
+
+ Note that the default mapper instance will be automatically created if
+ one of explicit configuration methods (like ProviderBase.configure(com.fasterxml.jackson.jaxrs.cfg.JaxRSFeature, boolean)
)
+ is called: if so, Provider-based introspection is NOT used, but the
+ resulting Mapper is used as configured.
+
+ Note that there is also a sub-class -- (JacksonJaxbYAMLProvider
) -- that
+ is configured by default to use both Jackson and JAXB annotations for configuration
+ (base class when used as-is defaults to using just Jackson annotations)
Modifier and Type | +Field and Description | +
---|---|
protected javax.ws.rs.ext.Providers |
+_providers
+Injectable context object used to locate configured
+ instance of
+YAMLMapper to use for actual
+ serialization. |
+
static Annotations[] |
+BASIC_ANNOTATIONS
+Default annotation sets to use, if not explicitly defined during
+ construction: only Jackson annotations are used for the base
+ class.
+ |
+
_cfgCheckCanDeserialize, _cfgCheckCanSerialize, _cfgCustomUntouchables, _defaultReadView, _defaultWriteView, _jaxRSFeatures, _mapperConfig, _readers, _unreadableClasses, _untouchables, _unwritableClasses, _writers, CLASS_NAME_NO_CONTENT_EXCEPTION, DEFAULT_UNREADABLES, DEFAULT_UNTOUCHABLES, DEFAULT_UNWRITABLES, HEADER_CONTENT_TYPE_OPTIONS, JAXRS_FEATURE_DEFAULTS
Constructor and Description | +
---|
JacksonYAMLProvider()
+Default constructor, usually used when provider is automatically
+ configured to be used with JAX-RS implementation.
+ |
+
JacksonYAMLProvider(Annotations... annotationsToUse) |
+
JacksonYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper) |
+
JacksonYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] annotationsToUse)
+Constructor to use when a custom mapper (usually components
+ like serializer/deserializer factories that have been configured)
+ is to be used.
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected YAMLEndpointConfig |
+_configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected YAMLEndpointConfig |
+_configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
protected com.fasterxml.jackson.core.JsonParser |
+_createParser(com.fasterxml.jackson.databind.ObjectReader reader,
+ InputStream rawStream)
+Overridable helper method called to create a
+JsonParser for reading
+ contents of given raw InputStream . |
+
com.fasterxml.jackson.dataformat.yaml.YAMLMapper |
+_locateMapperViaProvider(Class<?> type,
+ javax.ws.rs.core.MediaType mediaType)
+Method called to locate
+YAMLMapper to use for serialization
+ and deserialization. |
+
protected boolean |
+hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)
+Helper method used to check whether given media type
+ is YAML type or sub type.
+ |
+
com.fasterxml.jackson.core.Version |
+version()
+Method that will return version information stored in and read from jar
+ that contains this class.
+ |
+
_addSuperTypes, _configForReading, _configForWriting, _containedIn, _createGenerator, _createNoContentException, _endpointForReading, _endpointForWriting, _findCustomUntouchable, _isIgnorableForReading, _isIgnorableForWriting, _isSpecialReadable, _modifyHeaders, addUntouchable, checkCanDeserialize, checkCanSerialize, configure, configure, configure, configure, configure, disable, disable, disable, disable, disable, disable, enable, enable, enable, enable, enable, enable, findEncoding, findSuperTypes, findSuperTypes, getSize, hasMatchingMediaTypeForReading, hasMatchingMediaTypeForWriting, isEnabled, isReadable, isWriteable, locateMapper, readFrom, removeUntouchable, setAnnotationsToUse, setDefaultReadView, setDefaultView, setDefaultWriteView, setMapper, writeTo
public static final Annotations[] BASIC_ANNOTATIONS+
@Context +protected javax.ws.rs.ext.Providers _providers+
YAMLMapper
to use for actual
+ serialization.public JacksonYAMLProvider()+
public JacksonYAMLProvider(Annotations... annotationsToUse)+
annotationsToUse
- Annotation set(s) to use for configuring
+ data bindingpublic JacksonYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper)+
public JacksonYAMLProvider(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper, + Annotations[] annotationsToUse)+
annotationsToUse
- Sets of annotations (Jackson, JAXB) that provider should
+ supportpublic com.fasterxml.jackson.core.Version version()+
protected YAMLEndpointConfig _configForReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
_configForReading
in class ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
protected YAMLEndpointConfig _configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
_configForWriting
in class ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
protected boolean hasMatchingMediaType(javax.ws.rs.core.MediaType mediaType)+
MediaType.getSubtype()
returns "xml" or something
+ ending with "+yaml".hasMatchingMediaType
in class ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
public com.fasterxml.jackson.dataformat.yaml.YAMLMapper _locateMapperViaProvider(Class<?> type, + javax.ws.rs.core.MediaType mediaType)+
YAMLMapper
to use for serialization
+ and deserialization. If an instance has been explicitly defined by
+ ProviderBase.setMapper(MAPPER)
(or non-null instance passed in constructor), that
+ will be used.
+ If not, will try to locate it using standard JAX-RS
+ ContextResolver
mechanism, if it has been properly configured
+ to access it (by JAX-RS runtime).
+ Finally, if no mapper is found, will return a default unconfigured
+ ObjectMapper
instance (one constructed with default constructor
+ and not modified in any way)_locateMapperViaProvider
in class ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
type
- Class of object being serialized or deserialized;
+ not checked at this point, since it is assumed that unprocessable
+ classes have been already weeded out,
+ but will be passed to ContextResolver
as is.mediaType
- Declared media type for the instance to process:
+ not used by this method,
+ but will be passed to ContextResolver
as is.protected com.fasterxml.jackson.core.JsonParser _createParser(com.fasterxml.jackson.databind.ObjectReader reader, + InputStream rawStream) + throws IOException+
ProviderBase
JsonParser
for reading
+ contents of given raw InputStream
.
+ May return null to indicate that Stream is empty; that is, contains no
+ content._createParser
in class ProviderBase<JacksonYAMLProvider,com.fasterxml.jackson.dataformat.yaml.YAMLMapper,YAMLEndpointConfig,YAMLMapperConfigurator>
IOException
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/PackageVersion.html new file mode 100644 index 00000000..377ac05b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/PackageVersion.html @@ -0,0 +1,321 @@ + + + + + + +public final class PackageVersion +extends Object +implements com.fasterxml.jackson.core.Versioned+
Modifier and Type | +Field and Description | +
---|---|
static com.fasterxml.jackson.core.Version |
+VERSION |
+
Constructor and Description | +
---|
PackageVersion() |
+
Modifier and Type | +Method and Description | +
---|---|
com.fasterxml.jackson.core.Version |
+version() |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLEndpointConfig.html new file mode 100644 index 00000000..c05e5f3a --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLEndpointConfig.html @@ -0,0 +1,338 @@ + + + + + + +public class YAMLEndpointConfig +extends EndpointConfigBase<YAMLEndpointConfig>+
_activeView, _config, _deserDisable, _deserEnable, _reader, _rootName, _serDisable, _serEnable, _writer
Modifier | +Constructor and Description | +
---|---|
protected |
+YAMLEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config) |
+
Modifier and Type | +Method and Description | +
---|---|
static YAMLEndpointConfig |
+forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static YAMLEndpointConfig |
+forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Object |
+modifyBeforeWrite(Object value) |
+
add, addAnnotation, getActiveView, getReader, getRootName, getWriter, initReader, initWriter, nullIfEmpty
protected YAMLEndpointConfig(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)+
public static YAMLEndpointConfig forReading(com.fasterxml.jackson.databind.ObjectReader reader, + Annotation[] annotations)+
public static YAMLEndpointConfig forWriting(com.fasterxml.jackson.databind.ObjectWriter writer, + Annotation[] annotations)+
public Object modifyBeforeWrite(Object value)+
modifyBeforeWrite
in class EndpointConfigBase<YAMLEndpointConfig>
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMapperConfigurator.html new file mode 100644 index 00000000..d963fa7b --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMapperConfigurator.html @@ -0,0 +1,383 @@ + + + + + + +public class YAMLMapperConfigurator +extends MapperConfiguratorBase<YAMLMapperConfigurator,com.fasterxml.jackson.dataformat.yaml.YAMLMapper>+
YAMLMapper
instance to be used for data binding, as
+ well as accessing it._defaultAnnotationsToUse, _defaultMapper, _jaxbIntrospectorClass, _mapper
Constructor and Description | +
---|
YAMLMapperConfigurator(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper,
+ Annotations[] defAnnotations) |
+
Modifier and Type | +Method and Description | +
---|---|
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospector(Annotations ann) |
+
protected com.fasterxml.jackson.databind.AnnotationIntrospector |
+_resolveIntrospectors(Annotations[] annotationsToUse) |
+
com.fasterxml.jackson.dataformat.yaml.YAMLMapper |
+getConfiguredMapper()
+Method that locates, configures and returns
+YAMLMapper to use |
+
com.fasterxml.jackson.dataformat.yaml.YAMLMapper |
+getDefaultMapper() |
+
protected com.fasterxml.jackson.dataformat.yaml.YAMLMapper |
+mapper()
+Helper method that will ensure that there is a configurable non-default
+ mapper (constructing an instance if one didn't yet exit), and return
+ that mapper.
+ |
+
_setAnnotations, configure, configure, configure, configure, setAnnotationsToUse, setMapper
public YAMLMapperConfigurator(com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper, + Annotations[] defAnnotations)+
public com.fasterxml.jackson.dataformat.yaml.YAMLMapper getConfiguredMapper()+
YAMLMapper
to usegetConfiguredMapper
in class MapperConfiguratorBase<YAMLMapperConfigurator,com.fasterxml.jackson.dataformat.yaml.YAMLMapper>
public com.fasterxml.jackson.dataformat.yaml.YAMLMapper getDefaultMapper()+
getDefaultMapper
in class MapperConfiguratorBase<YAMLMapperConfigurator,com.fasterxml.jackson.dataformat.yaml.YAMLMapper>
protected com.fasterxml.jackson.dataformat.yaml.YAMLMapper mapper()+
mapper
in class MapperConfiguratorBase<YAMLMapperConfigurator,com.fasterxml.jackson.dataformat.yaml.YAMLMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospectors(Annotations[] annotationsToUse)+
_resolveIntrospectors
in class MapperConfiguratorBase<YAMLMapperConfigurator,com.fasterxml.jackson.dataformat.yaml.YAMLMapper>
protected com.fasterxml.jackson.databind.AnnotationIntrospector _resolveIntrospector(Annotations ann)+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMediaTypes.html new file mode 100644 index 00000000..5bbfeb3e --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/YAMLMediaTypes.html @@ -0,0 +1,322 @@ + + + + + + +public class YAMLMediaTypes +extends Object+
Modifier and Type | +Field and Description | +
---|---|
static String |
+APPLICATION_JACKSON_YAML |
+
static javax.ws.rs.core.MediaType |
+APPLICATION_JACKSON_YAML_TYPE |
+
static String |
+TEXT_JACKSON_YAML |
+
static javax.ws.rs.core.MediaType |
+TEXT_JACKSON_YAML_TYPE |
+
Constructor and Description | +
---|
YAMLMediaTypes() |
+
public static final String APPLICATION_JACKSON_YAML+
public static final javax.ws.rs.core.MediaType APPLICATION_JACKSON_YAML_TYPE+
public static final String TEXT_JACKSON_YAML+
public static final javax.ws.rs.core.MediaType TEXT_JACKSON_YAML_TYPE+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonJaxbYAMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonJaxbYAMLProvider.html new file mode 100644 index 00000000..e1f50dc9 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonJaxbYAMLProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonYAMLProvider.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonYAMLProvider.html new file mode 100644 index 00000000..be3dcd76 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/JacksonYAMLProvider.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Class and Description | +
---|---|
class |
+JacksonJaxbYAMLProvider
+JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/PackageVersion.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/PackageVersion.html new file mode 100644 index 00000000..847cb168 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/PackageVersion.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLEndpointConfig.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLEndpointConfig.html new file mode 100644 index 00000000..187a5d75 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLEndpointConfig.html @@ -0,0 +1,186 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Modifier and Type | +Method and Description | +
---|---|
protected YAMLEndpointConfig |
+JacksonYAMLProvider._configForReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
protected YAMLEndpointConfig |
+JacksonYAMLProvider._configForWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
static YAMLEndpointConfig |
+YAMLEndpointConfig.forReading(com.fasterxml.jackson.databind.ObjectReader reader,
+ Annotation[] annotations) |
+
static YAMLEndpointConfig |
+YAMLEndpointConfig.forWriting(com.fasterxml.jackson.databind.ObjectWriter writer,
+ Annotation[] annotations) |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMapperConfigurator.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMapperConfigurator.html new file mode 100644 index 00000000..93a80891 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMapperConfigurator.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMediaTypes.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMediaTypes.html new file mode 100644 index 00000000..227d8c26 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/class-use/YAMLMediaTypes.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-frame.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-frame.html new file mode 100644 index 00000000..b0ffbdaf --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +See: Description
+Class | +Description | +
---|---|
JacksonJaxbYAMLProvider | +
+ JSON content type provider automatically configured to use both Jackson
+ and JAXB annotations (in that order of priority).
+ |
+
JacksonYAMLProvider | +
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
PackageVersion | +
+ Automatically generated from PackageVersion.java.in during
+ packageVersion-generate execution of maven-replacer-plugin in
+ pom.xml.
+ |
+
YAMLEndpointConfig | +
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
YAMLMapperConfigurator | +
+ Helper class used to encapsulate details of configuring an
+
+YAMLMapper instance to be used for data binding, as
+ well as accessing it. |
+
YAMLMediaTypes | ++ |
+ Also continues supporting functionality, such as + exception mappers that can simplify handling of + error conditions. +
+ There are two default provider classes: +
JacksonYAMLProvider
is the basic
+ provider configured to use Jackson annotations
+ JacksonJaxbYAMLProvider
is extension
+ of the basic provider, configured to additionally use JAXB annotations,
+ in addition to (or in addition of, if so configured) Jackson annotations.
+ Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-tree.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-tree.html new file mode 100644 index 00000000..7ef8e62f --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-use.html b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-use.html new file mode 100644 index 00000000..e75bb4d0 --- /dev/null +++ b/docs/javadoc/2.13/com/fasterxml/jackson/jaxrs/yaml/package-use.html @@ -0,0 +1,173 @@ + + + + + + +Package | +Description | +
---|---|
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Class and Description | +
---|
JacksonYAMLProvider
+ Basic implementation of JAX-RS abstractions (
+MessageBodyReader ,
+ MessageBodyWriter ) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s). |
+
YAMLEndpointConfig
+ Container class for figuring out annotation-based configuration
+ for JAX-RS end points.
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/constant-values.html b/docs/javadoc/2.13/constant-values.html new file mode 100644 index 00000000..1f025485 --- /dev/null +++ b/docs/javadoc/2.13/constant-values.html @@ -0,0 +1,260 @@ + + + + + + +Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+protected static final String |
+CLASS_NAME_NO_CONTENT_EXCEPTION |
+"javax.ws.rs.core.NoContentException" |
+
+
+public static final String |
+HEADER_CONTENT_TYPE_OPTIONS |
+"X-Content-Type-Options" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+APPLICATION_JACKSON_CBOR |
+"application/cbor" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+MIME_JAVASCRIPT |
+"application/javascript" |
+
+
+public static final String |
+MIME_JAVASCRIPT_MS |
+"application/x-javascript" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+APPLICATION_JACKSON_SMILE |
+"application/x-jackson-smile" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+APPLICATION_JACKSON_YAML |
+"application/yaml" |
+
+
+public static final String |
+TEXT_JACKSON_YAML |
+"text/yaml" |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/deprecated-list.html b/docs/javadoc/2.13/deprecated-list.html new file mode 100644 index 00000000..95bfa4d3 --- /dev/null +++ b/docs/javadoc/2.13/deprecated-list.html @@ -0,0 +1,148 @@ + + + + + + +Constructor and Description | +
---|
com.fasterxml.jackson.jaxrs.base.ProviderBase() | +
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/help-doc.html b/docs/javadoc/2.13/help-doc.html new file mode 100644 index 00000000..26b2b5ac --- /dev/null +++ b/docs/javadoc/2.13/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object
. The interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/index-all.html b/docs/javadoc/2.13/index-all.html new file mode 100644 index 00000000..37ddbd79 --- /dev/null +++ b/docs/javadoc/2.13/index-all.html @@ -0,0 +1,1598 @@ + + + + + + +ObjectMapper
instance to be used for data binding, as
+ well as accessing it.ProviderBase.isReadable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called.ProviderBase.isWriteable(java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType)
+ is called.Class
.BeanProperty
implementation used for passing annotations
+ from JAX-RS endpoint into Jackson.ObjectMapper
to useObjectMapper
to useObjectMapper
to useObjectMapper
to useXmlMapper
to useYAMLMapper
to useMessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s).ObjectReader
s and ObjectWriter
s.MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ Smile ("application/x-jackson-smile") content to and from Java Objects ("POJO"s).MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).MessageBodyReader
,
+ MessageBodyWriter
) needed for binding
+ JSON ("application/json") content to and from Java Objects ("POJO"s).Link
: serialized using "link header" representation
+
+ ObjectMapper
instance to be used for data binding, as
+ well as accessing it.ExceptionMapper
to send down a "400 Bad Request"
+ response in the event that unmappable JSON is received.JSONP
+ annotation instance.ExceptionMapper
to send down a "400 Bad Request"
+ in the event unparsable JSON is received.ObjectMapper
to use for serialization
+ and deserialization.ObjectMapper
instance to be used for data binding, as
+ well as accessing it.ObjectReaderModifier
) that can be used to
+ reconfigure ObjectReader
+ that JAX-RS Resource will use for reading input into Java Objects.ObjectWriter
+ that JAX-RS Resource will use; usually this is done from a Servlet or JAX-RS filter
+ before execution reaches resource.ObjectMapper
to use
+ for serialization and deserialization; if null, will use the standard
+ provider discovery from context instead.ObjectMapper
instance to be used for data binding, as
+ well as accessing it.XmlMapper
instance to be used for data binding, as
+ well as accessing it.YAMLMapper
instance to be used for data binding, as
+ well as accessing it.true
meaning that entry is untouchable,
+ false
that is is not.JsonGenerator
for writing
+ contents into given raw OutputStream
.JsonParser
for reading
+ contents of given raw InputStream
.MapperConfiguratorBase.setAnnotationsToUse(com.fasterxml.jackson.jaxrs.cfg.Annotations[])
ObjectReader
to use for deserializing
+ contentThreadLocal
access in cases
+ where this feature is not being usedThreadLocal
access in cases
+ where this feature is not being usedObjectMapper
to use for serialization
+ and deserialization.ObjectMapper
to use for serialization
+ and deserialization.XmlMapper
to use for serialization
+ and deserialization.YAMLMapper
to use for serialization
+ and deserialization.ObjectMapper
ObjectMapper
to use for actual
+ serialization.ObjectMapper
to use for actual
+ serialization.ObjectMapper
to use for actual
+ serialization.XmlMapper
to use for actual
+ serialization.YAMLMapper
to use for actual
+ serialization.Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/index.html b/docs/javadoc/2.13/index.html new file mode 100644 index 00000000..9f6fbd15 --- /dev/null +++ b/docs/javadoc/2.13/index.html @@ -0,0 +1,76 @@ + + + + + + ++ + diff --git a/docs/javadoc/2.13/overview-summary.html b/docs/javadoc/2.13/overview-summary.html new file mode 100644 index 00000000..60ce321f --- /dev/null +++ b/docs/javadoc/2.13/overview-summary.html @@ -0,0 +1,206 @@ + + + + + + +
Package | +Description | +
---|---|
com.fasterxml.jackson.datatype.jaxrs | ++ |
com.fasterxml.jackson.jaxrs.annotation | +
+ Package that contains annotations applicable to all content types.
+ |
+
com.fasterxml.jackson.jaxrs.base | ++ |
com.fasterxml.jackson.jaxrs.cbor | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Compact Binary Object Representation (CBOR) content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.cfg | ++ |
com.fasterxml.jackson.jaxrs.json | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ JSON content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.json.annotation | +
+ Package that contains annotations specific to JSON dataformat.
+ |
+
com.fasterxml.jackson.jaxrs.smile | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ Smile content type.
+ |
+
com.fasterxml.jackson.jaxrs.util | +
+ Miscellaneous helper classes used by providers.
+ |
+
com.fasterxml.jackson.jaxrs.xml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ XML content type (MediaType).
+ |
+
com.fasterxml.jackson.jaxrs.yaml | +
+ Jackson-based JAX-RS provider that can automatically
+ serialize and deserialize resources for
+ YAML content type (MediaType).
+ |
+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/overview-tree.html b/docs/javadoc/2.13/overview-tree.html new file mode 100644 index 00000000..0c213860 --- /dev/null +++ b/docs/javadoc/2.13/overview-tree.html @@ -0,0 +1,271 @@ + + + + + + +Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/package-list b/docs/javadoc/2.13/package-list new file mode 100644 index 00000000..426b400a --- /dev/null +++ b/docs/javadoc/2.13/package-list @@ -0,0 +1,11 @@ +com.fasterxml.jackson.datatype.jaxrs +com.fasterxml.jackson.jaxrs.annotation +com.fasterxml.jackson.jaxrs.base +com.fasterxml.jackson.jaxrs.cbor +com.fasterxml.jackson.jaxrs.cfg +com.fasterxml.jackson.jaxrs.json +com.fasterxml.jackson.jaxrs.json.annotation +com.fasterxml.jackson.jaxrs.smile +com.fasterxml.jackson.jaxrs.util +com.fasterxml.jackson.jaxrs.xml +com.fasterxml.jackson.jaxrs.yaml diff --git a/docs/javadoc/2.13/script.js b/docs/javadoc/2.13/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadoc/2.13/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/2.13/serialized-form.html b/docs/javadoc/2.13/serialized-form.html new file mode 100644 index 00000000..2f15e398 --- /dev/null +++ b/docs/javadoc/2.13/serialized-form.html @@ -0,0 +1,193 @@ + + + + + + +com.fasterxml.jackson.databind.introspect.AnnotationMap _annotations+
int _maxEntries+
Copyright © 2021 FasterXML. All rights reserved.
+ + diff --git a/docs/javadoc/2.13/stylesheet.css b/docs/javadoc/2.13/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadoc/2.13/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/pom.xml b/pom.xml index b27a2d82..a05ef34d 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@