From 00a8c72eb4b56cfcfe1ea815cfcdcfbcc97b183e Mon Sep 17 00:00:00 2001 From: Tatu Saloranta Date: Mon, 4 Jan 2021 16:58:42 -0800 Subject: [PATCH] more javadoc stuff --- .../jackson/core/async/NonBlockingInputFeeder.java | 6 +++++- src/main/java/com/fasterxml/jackson/core/io/CharTypes.java | 7 +++++++ .../java/com/fasterxml/jackson/core/util/InternCache.java | 3 +-- .../fasterxml/jackson/core/util/JsonParserSequence.java | 4 +--- .../fasterxml/jackson/core/util/MinimalPrettyPrinter.java | 2 ++ .../java/com/fasterxml/jackson/core/util/TextBuffer.java | 2 +- 6 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/main/java/com/fasterxml/jackson/core/async/NonBlockingInputFeeder.java b/src/main/java/com/fasterxml/jackson/core/async/NonBlockingInputFeeder.java index d74ac64c3e..14a3a50ffa 100644 --- a/src/main/java/com/fasterxml/jackson/core/async/NonBlockingInputFeeder.java +++ b/src/main/java/com/fasterxml/jackson/core/async/NonBlockingInputFeeder.java @@ -18,12 +18,16 @@ public interface NonBlockingInputFeeder * Method called to check whether it is ok to feed more data: parser returns true * if it has no more content to parse (and it is ok to feed more); otherwise false * (and no data should yet be fed). + * + * @return {@code True} if more input is needed (and can be fed); {@code false} if + * there is still some input to decode */ public boolean needMoreInput(); /** * Method that should be called after last chunk of data to parse has been fed - * (with feedInput in sub-class); can be called regardless of what {@link #needMoreInput} + * (with {@code feedInput} in sub-class); can be called regardless of what + * {@link #needMoreInput} * returns. After calling this method, no more data can be fed; and parser assumes * no more data will be available. */ diff --git a/src/main/java/com/fasterxml/jackson/core/io/CharTypes.java b/src/main/java/com/fasterxml/jackson/core/io/CharTypes.java index 85596e3652..1f1c12e5ab 100644 --- a/src/main/java/com/fasterxml/jackson/core/io/CharTypes.java +++ b/src/main/java/com/fasterxml/jackson/core/io/CharTypes.java @@ -206,6 +206,8 @@ public final class CharTypes * Value of 0 means "no escaping"; other positive values that value is character * to use after backslash; and negative values that generic (backslash - u) * escaping is to be used. + * + * @return 128-entry {@code int[]} that contains escape definitions */ public static int[] get7BitOutputEscapes() { return sOutputEscapes128; } @@ -213,6 +215,11 @@ public final class CharTypes * Alternative to {@link #get7BitOutputEscapes()} when a non-standard quote character * is used. * + * @param quoteChar Character used for quoting textual values and property names; + * usually double-quote but sometimes changed to single-quote (apostrophe) + * + * @return 128-entry {@code int[]} that contains escape definitions + * * @since 2.10 */ public static int[] get7BitOutputEscapes(int quoteChar) { diff --git a/src/main/java/com/fasterxml/jackson/core/util/InternCache.java b/src/main/java/com/fasterxml/jackson/core/util/InternCache.java index 8e8b3484a0..b90a8a6a1c 100644 --- a/src/main/java/com/fasterxml/jackson/core/util/InternCache.java +++ b/src/main/java/com/fasterxml/jackson/core/util/InternCache.java @@ -1,6 +1,5 @@ package com.fasterxml.jackson.core.util; -import java.util.LinkedHashMap; import java.util.concurrent.ConcurrentHashMap; /** @@ -9,7 +8,7 @@ * performance optimization, to avoid calling native intern() method * in cases where same String is being interned multiple times. *

- * Note: that this class extends {@link LinkedHashMap} is an implementation + * Note: that this class extends {@link java.util.LinkedHashMap} is an implementation * detail -- no code should ever directly call Map methods. */ public final class InternCache diff --git a/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java b/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java index a49c4b1237..bed1ae4dde 100644 --- a/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java +++ b/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java @@ -60,9 +60,7 @@ protected JsonParserSequence(JsonParser[] parsers) { this(false, parsers); } - /** - * @since 2.8 - */ + // @since 2.8 protected JsonParserSequence(boolean checkForExistingToken, JsonParser[] parsers) { super(parsers[0]); diff --git a/src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java b/src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java index 99a62678d5..411662bbc9 100644 --- a/src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java +++ b/src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java @@ -54,6 +54,8 @@ public void setRootValueSeparator(String sep) { } /** + * @param separators Separator definitions + * * @since 2.9 */ public MinimalPrettyPrinter setSeparators(Separators separators) { diff --git a/src/main/java/com/fasterxml/jackson/core/util/TextBuffer.java b/src/main/java/com/fasterxml/jackson/core/util/TextBuffer.java index 16ed81f2b1..12af044700 100644 --- a/src/main/java/com/fasterxml/jackson/core/util/TextBuffer.java +++ b/src/main/java/com/fasterxml/jackson/core/util/TextBuffer.java @@ -7,7 +7,7 @@ import com.fasterxml.jackson.core.io.NumberInput; /** - * TextBuffer is a class similar to {@link StringBuffer}, with + * TextBuffer is a class similar to {@link java.lang.StringBuffer}, with * following differences: *