Skip to content

Commit 27b04f8

Browse files
committed
Javadoc warning fixes
1 parent 4c1db5e commit 27b04f8

File tree

11 files changed

+26
-28
lines changed

11 files changed

+26
-28
lines changed

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/AvroFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ protected AvroFactory(AvroFactory src, ObjectCodec oc)
102102
}
103103

104104
/**
105-
* Constructors used by {@link YAMLFactoryBuilder} for instantiation.
105+
* Constructors used by {@link AvroFactoryBuilder} for instantiation.
106106
*
107107
* @since 2.9
108108
*/

cbor/src/main/java/com/fasterxml/jackson/dataformat/cbor/CBORParser.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -910,7 +910,7 @@ protected JsonToken _handleTaggedArray(int tag, int len) throws IOException
910910
}
911911

912912
/**
913-
* Heavily simplified method that does a subset of what {@code nextTokendoes to basically
913+
* Heavily simplified method that does a subset of what {@code nextToken()} does to basically
914914
* only (1) determine that we are getting {@code JsonToken.VALUE_NUMBER_INT} (if not,
915915
* return with no processing) and (2) if so, prepare state so that number accessor
916916
* method will work).

ion/src/main/java/com/fasterxml/jackson/dataformat/ion/polymorphism/IonAnnotationIntrospector.java

+6-7
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,19 @@
2727
* A Jackson {@link com.fasterxml.jackson.databind.AnnotationIntrospector} (essentially an interceptor for
2828
* serializer/deserializer construction) that provides type serializer/deserializers that write/read Ion type
2929
* annotations.
30-
* <p/>
30+
* <p>
3131
* The logic in this class is very similar to {@link com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector}!
3232
* We both look at the @JsonTypeResolver, etc annotations and try to make type resolvers.
33-
* <p/>
33+
* <p>
3434
* This class adds a {@code resolveAllTypes} override, which allows for universal polymorphism without needing
3535
* any annotations or mixins, and also permits top-level polymorphism -- deserialize to any object without providing its
3636
* actual type, as long as type information was serialized. (i.e., ObjectMapper#readValue(serializedData, Object.class))
37-
* <p/>
37+
* <p>
3838
* Note: the provided {@link com.fasterxml.jackson.databind.jsontype.TypeSerializer} will only write type annotations if the configured
3939
* {@link TypeIdResolver} returns non-null.
40-
* <p/>
40+
* <p>
4141
* Note: {@link com.fasterxml.jackson.databind.jsontype.TypeDeserializer} are actually full-on value deserializers -- all
4242
* deserialization logic goes through them (unlike TypeSerializers, which just write the type metadata).
43-
* <p/>
4443
*/
4544
public class IonAnnotationIntrospector extends NopAnnotationIntrospector {
4645
private static final long serialVersionUID = 1L;
@@ -63,10 +62,10 @@ protected boolean shouldResolveType(AnnotatedClass ac) {
6362
/**
6463
* Provides a {@link TypeResolverBuilder} if the {@link AnnotatedClass} is enabled for type resolving, and a
6564
* {@link TypeIdResolver} can be instantiated.
66-
* <p/>
65+
* <p>
6766
* The AnnotatedClass is enabled for type resolving if either {@code resolveAllTypes} is set, or shouldResolveType()
6867
* returns true.
69-
* <p/>
68+
* <p>
7069
* We look for a TypeIdResolver by checking for a {@link JsonTypeIdResolver} annotation, and fallback to
7170
* {@code defaultIdResolver()}.
7271
*

ion/src/main/java/com/fasterxml/jackson/dataformat/ion/polymorphism/IonAnnotationTypeDeserializer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* This is a {@link com.fasterxml.jackson.databind.jsontype.TypeDeserializer} that reads typing metadata from Ion type
3434
* annotations. Annotations found are processed by the configured {@link TypeIdResolver} to provide a concrete Java
3535
* class, which is in turn used to find the appropriate {@link JsonDeserializer}, and execute it.
36-
* <p/>
36+
* <p>
3737
* If multiple annotations are found, the first annotation to resolve to a non-null {@link JavaType} using the
3838
* configured {@link TypeIdResolver} is used. Ion provides type annotations in alphabetic order.
3939
*

ion/src/main/java/com/fasterxml/jackson/dataformat/ion/polymorphism/IonAnnotationTypeResolverBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
/**
3030
* A {@link TypeResolverBuilder} which produces {@link TypeSerializer}s and {@link TypeDeserializer}s that use
3131
* Ion type annotations to communicate type metadata. Jackson polymorphism, the Ion way.
32-
*
32+
*<p>
3333
* This TypeResolverBuilder expects to be initialized with a functional {@link TypeIdResolver}, and will serialize
3434
* type information (and deserialize to something other than the default type) when it resolves the provided
3535
* {@link JavaType} to a non-null type identifier, and vice versa.

ion/src/main/java/com/fasterxml/jackson/dataformat/ion/polymorphism/MultipleTypeIdResolver.java

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@
2020
* This is an extension of {@link TypeIdResolver} for serializing and deserializing polymorphic types. The vanilla
2121
* implementation of TypeIdResolver only enables a single type id to be serialized with a value, which is not always
2222
* sufficient for every consumer of a value with polymorphic typing to identify and instantiate the appropriate type.
23-
* <p/>
23+
* <p>
2424
* This allows more robust polymorphism support, in that consumers of a serialized polymorphic object do not need
2525
* complete type information. As long as their deserializer can resolve (or, understand) one of the annotated type ids,
2626
* they can still perform polymorphic deserialization. An example:
27-
* <p/>
27+
* <p>
2828
* <pre>
2929
* class BasicMessage {
3030
* String id;
@@ -33,22 +33,22 @@
3333
* class SocialMediaMessage extends BasicMessage {
3434
* boolean cool;
3535
* }
36-
*
36+
*</pre>
3737
* Let's say we serialized a value into:
38-
*
38+
*<pre>
3939
* {id="123",message="hi",cool=false}.
40-
*
40+
*</pre>
4141
* The existing polymorphism support may have annotated this as the following Ion:
42-
*
42+
*<pre>
4343
* SocialMediaMessage::{id="123",message="hi",cool=false}
44-
*
44+
*</pre>
4545
* But a consumer who only has BasicMessage in its classloader won't know (or care) what a SocialMediaMessage is, and be
4646
* stuck. Using this interface enables the following serialization:
47-
*
47+
*<pre>
4848
* SocialMediaMessage::BasicMessage::{id="123",message="hi",cool=false}
49-
*
49+
*</pre>
5050
* About particular implementations:
51-
* <p/>
51+
* <p>
5252
* Ion serialization should be using {@link IonAnnotationTypeSerializer}, which is polymorphism-aware, but how should a
5353
* MultipleTypeIdResolver handle a call to the non-polymorphic {@link TypeIdResolver#idFromValue(Object)}? I'd probably
5454
* do something like {@code return selectId(idsFromValue(value)); }, to keep things working when serializing
@@ -72,7 +72,7 @@ public interface MultipleTypeIdResolver extends TypeIdResolver {
7272
* {@link TypeIdResolver#typeFromId} to get a {@link com.fasterxml.jackson.databind.JavaType}. It is a invariant
7373
* on this method that its output, if non-null, be valid input for {@link TypeIdResolver#typeFromId} of the
7474
* same TypeIdResolver instance.
75-
* <p/>
75+
* <p>
7676
* Note that we're not resolving the array of ids directly into a JavaType because there is code (in the Jackson
7777
* package, not ours) which consumes the id String itself, not the JavaType object.
7878
*

pom.xml

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>com.fasterxml.jackson</groupId>
55
<artifactId>jackson-base</artifactId>
6-
<version>2.11.0-SNAPSHOT</version>
6+
<version>2.11.0</version>
77
</parent>
88
<groupId>com.fasterxml.jackson.dataformat</groupId>
99
<artifactId>jackson-dataformats-binary</artifactId>
@@ -34,7 +34,6 @@
3434

3535
<properties>
3636
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
37-
<version.asm>6.2.1</version.asm>
3837
</properties>
3938

4039
<dependencies>

protobuf/src/main/java/com/fasterxml/jackson/dataformat/protobuf/ProtobufFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ protected ProtobufFactory(ProtobufFactory src, ObjectCodec oc)
3131
}
3232

3333
/**
34-
* Constructors used by {@link CBORFactoryBuilder} for instantiation.
34+
* Constructors used by {@link ProtobufFactoryBuilder} for instantiation.
3535
*
3636
* @since 2.9
3737
*/

release-notes/VERSION-2.x

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Project: jackson-datatypes-binaryModules:
88
=== Releases ===
99
------------------------------------------------------------------------
1010

11-
2.11.0 (not yet released)
11+
2.11.0 (26-Apr-2020)
1212

1313
#179: (avro) Add `AvroGenerator.canWriteBinaryNatively()` to support binary writes,
1414
fix `java.util.UUID` representation

smile/src/main/java/com/fasterxml/jackson/dataformat/smile/SmileConstants.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public final class SmileConstants
4545

4646
/**
4747
* Longest back reference we use for short shared String values is 10 bits,
48-
* so up to (1 << 10) values to keep track of.
48+
* so up to {@code (1 << 10)} values to keep track of.
4949
*/
5050
public final static int MAX_SHARED_STRING_VALUES = 1024;
5151

smile/src/main/java/com/fasterxml/jackson/dataformat/smile/SmileParserBase.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public abstract class SmileParserBase extends ParserMinimalBase
9696
protected long _currInputProcessed;
9797

9898
/**
99-
* Alternative to {@link #_tokenInputTotal} that will only contain
99+
* Alternative to {@code _tokenInputTotal} that will only contain
100100
* offset within input buffer, as int.
101101
*/
102102
protected int _tokenOffsetForTotal;

0 commit comments

Comments
 (0)