diff --git a/src/main/java/com/fasterxml/jackson/core/PrettyPrinter.java b/src/main/java/com/fasterxml/jackson/core/PrettyPrinter.java index 0c8e518682..ecd0bc0b8b 100644 --- a/src/main/java/com/fasterxml/jackson/core/PrettyPrinter.java +++ b/src/main/java/com/fasterxml/jackson/core/PrettyPrinter.java @@ -51,11 +51,15 @@ public interface PrettyPrinter * Method called after a root-level value has been completely * output, and before another value is to be output. *
- * Default - * handling (without pretty-printing) will output a space, to + * Default handling (without pretty-printing) will output a space, to * allow values to be parsed correctly. Pretty-printer is * to output some other suitable and nice-looking separator * (tab(s), space(s), linefeed(s) or any combination thereof). + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeRootValueSeparator(JsonGenerator gen) throws IOException; @@ -70,6 +74,11 @@ public interface PrettyPrinter * Pretty-printer is * to output a curly bracket as well, but can surround that * with other (white-space) decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeStartObject(JsonGenerator gen) throws IOException; @@ -83,19 +92,28 @@ public interface PrettyPrinter * to output a curly bracket as well, but can surround that * with other (white-space) decoration. * - * @param nrOfEntries Number of direct members of the array that + * @param gen Generator used for output + * @param nrOfEntries Number of direct members of the Object that * have been output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeEndObject(JsonGenerator gen, int nrOfEntries) throws IOException; /** - * Method called after an object entry (field:value) has been completely + * Method called after an Object entry (field:value) has been completely * output, and before another value is to be output. *
* Default handling (without pretty-printing) will output a single * comma to separate the two. Pretty-printer is * to output a comma as well, but can surround that with other * (white-space) decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeObjectEntrySeparator(JsonGenerator gen) throws IOException; @@ -107,6 +125,11 @@ public interface PrettyPrinter * colon to separate the two. Pretty-printer is * to output a colon as well, but can surround that with other * (white-space) decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeObjectFieldValueSeparator(JsonGenerator gen) throws IOException; @@ -121,6 +144,11 @@ public interface PrettyPrinter * Pretty-printer is * to output a bracket as well, but can surround that * with other (white-space) decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeStartArray(JsonGenerator gen) throws IOException; @@ -134,8 +162,12 @@ public interface PrettyPrinter * to output a bracket as well, but can surround that * with other (white-space) decoration. * + * @param gen Generator used for output * @param nrOfValues Number of direct members of the array that * have been output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeEndArray(JsonGenerator gen, int nrOfValues) throws IOException; @@ -147,14 +179,18 @@ public interface PrettyPrinter * comma to separate the two. Pretty-printer is * to output a comma as well, but can surround that with other * (white-space) decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void writeArrayValueSeparator(JsonGenerator gen) throws IOException; /* /********************************************************** - /* Then events that by default do not produce any output - /* but that are often overridden to add white space - /* in pretty-printing mode + /* Then events that by default do not produce any output but that are + /* often overridden to add white space in pretty-printing mode /********************************************************** */ @@ -165,6 +201,11 @@ public interface PrettyPrinter *
* Default handling does not output anything, but pretty-printer * is free to add any white space decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void beforeArrayValues(JsonGenerator gen) throws IOException; @@ -176,6 +217,11 @@ public interface PrettyPrinter *
* Default handling does not output anything, but pretty-printer * is free to add any white space decoration. + * + * @param gen Generator used for output + * + * @throws IOException if there is either an underlying I/O problem or encoding + * issue at format layer */ void beforeObjectEntries(JsonGenerator gen) throws IOException; } diff --git a/src/main/java/com/fasterxml/jackson/core/SerializableString.java b/src/main/java/com/fasterxml/jackson/core/SerializableString.java index 73dab3d23a..79ed83c79b 100644 --- a/src/main/java/com/fasterxml/jackson/core/SerializableString.java +++ b/src/main/java/com/fasterxml/jackson/core/SerializableString.java @@ -26,6 +26,8 @@ public interface SerializableString /** * Returns unquoted String that this object represents (and offers * serialized forms for) + * + * @return Unquoted String */ String getValue(); @@ -35,6 +37,8 @@ public interface SerializableString *
* getValue().length(); *+ * + * @return Length of the String in characters */ int charLength(); @@ -47,6 +51,8 @@ public interface SerializableString /** * Returns JSON quoted form of the String, as character array. * Result can be embedded as-is in textual JSON as property name or JSON String. + * + * @return JSON quoted form of the String as {@code char[]} */ char[] asQuotedChars(); @@ -56,6 +62,8 @@ public interface SerializableString *
* getValue().getBytes("UTF-8"); *+ * + * @return UTF-8 encoded version of String, without any escaping */ byte[] asUnquotedUTF8(); @@ -65,6 +73,8 @@ public interface SerializableString *
* new String(asQuotedChars()).getBytes("UTF-8"); *+ * + * @return UTF-8 encoded version of JSON-escaped String */ byte[] asQuotedUTF8(); @@ -83,7 +93,10 @@ public interface SerializableString * System.arraycopy(bytes, 0, buffer, offset, bytes.length); * return bytes.length; * - * + * + * @param buffer Buffer to append JSON-escaped String into + * @param offset Offset in {@code buffer} to append String at + * * @return Number of bytes appended, if successful, otherwise -1 */ int appendQuotedUTF8(byte[] buffer, int offset); @@ -96,6 +109,9 @@ public interface SerializableString * System.arraycopy(ch, 0, buffer, offset, ch.length); * return ch.length; * + * + * @param buffer Buffer to append JSON-escaped String into + * @param offset Offset in {@code buffer} to append String at * * @return Number of characters appended, if successful, otherwise -1 */ @@ -109,12 +125,14 @@ public interface SerializableString * System.arraycopy(bytes, 0, buffer, offset, bytes.length); * return bytes.length; * + * + * @param buffer Buffer to append literal (unescaped) String into + * @param offset Offset in {@code buffer} to append String at * * @return Number of bytes appended, if successful, otherwise -1 */ int appendUnquotedUTF8(byte[] buffer, int offset); - /** * Method that will append unquoted characters of this String into given * buffer. Functionally equivalent to: @@ -123,6 +141,9 @@ public interface SerializableString * System.arraycopy(bytes, 0, buffer, offset, ch.length); * return ch.length; * + * + * @param buffer Buffer to append literal (unescaped) String into + * @param offset Offset in {@code buffer} to append String at * * @return Number of characters appended, if successful, otherwise -1 */ @@ -135,22 +156,50 @@ public interface SerializableString */ /** + * Method for writing JSON-escaped UTF-8 encoded String value using given + * {@link OutputStream}. + * + * @param out {@link OutputStream} to write String into + * * @return Number of bytes written + * + * @throws IOException if underlying stream write fails */ int writeQuotedUTF8(OutputStream out) throws IOException; /** + * Method for writing unescaped UTF-8 encoded String value using given + * {@link OutputStream}. + * + * @param out {@link OutputStream} to write String into + * * @return Number of bytes written + * + * @throws IOException if underlying stream write fails */ int writeUnquotedUTF8(OutputStream out) throws IOException; /** - * @return Number of bytes put, if successful, otherwise -1 + * Method for appending JSON-escaped UTF-8 encoded String value into given + * {@link ByteBuffer}, if it fits. + * + * @param buffer {@link ByteBuffer} to append String into + * + * @return Number of bytes put, if contents fit, otherwise -1 + * + * @throws IOException if underlying buffer append operation fails */ int putQuotedUTF8(ByteBuffer buffer) throws IOException; /** - * @return Number of bytes put, if successful, otherwise -1 - */ - int putUnquotedUTF8(ByteBuffer out) throws IOException; + * Method for appending unquoted ('raw') UTF-8 encoded String value into given + * {@link ByteBuffer}, if it fits. + * + * @param buffer {@link ByteBuffer} to append String into + * + * @return Number of bytes put, if contents fit, otherwise -1 + * + * @throws IOException if underlying buffer append operation fails + */ + int putUnquotedUTF8(ByteBuffer buffer) throws IOException; } diff --git a/src/main/java/com/fasterxml/jackson/core/StreamReadFeature.java b/src/main/java/com/fasterxml/jackson/core/StreamReadFeature.java index c46a0015f7..4169755be5 100644 --- a/src/main/java/com/fasterxml/jackson/core/StreamReadFeature.java +++ b/src/main/java/com/fasterxml/jackson/core/StreamReadFeature.java @@ -116,6 +116,8 @@ private StreamReadFeature(JsonParser.Feature mapTo) { /** * Method that calculates bit set (flags) of all features that * are enabled by default. + * + * @return Bit mask of all features that are enabled by default */ public static int collectDefaults() { diff --git a/src/main/java/com/fasterxml/jackson/core/StreamWriteFeature.java b/src/main/java/com/fasterxml/jackson/core/StreamWriteFeature.java index 30dce8b10d..4f1998484e 100644 --- a/src/main/java/com/fasterxml/jackson/core/StreamWriteFeature.java +++ b/src/main/java/com/fasterxml/jackson/core/StreamWriteFeature.java @@ -135,6 +135,8 @@ private StreamWriteFeature(JsonGenerator.Feature mappedTo) { /** * Method that calculates bit set (flags) of all features that * are enabled by default. + * + * @return Bit mask of all features that are enabled by default */ public static int collectDefaults() { diff --git a/src/main/java/com/fasterxml/jackson/core/TreeCodec.java b/src/main/java/com/fasterxml/jackson/core/TreeCodec.java index 8ea8d51e41..7b4e625723 100644 --- a/src/main/java/com/fasterxml/jackson/core/TreeCodec.java +++ b/src/main/java/com/fasterxml/jackson/core/TreeCodec.java @@ -14,6 +14,9 @@ public abstract class TreeCodec public abstract void writeTree(JsonGenerator g, TreeNode tree) throws IOException, JsonProcessingException; /** + * @return Node that represents "missing" node during traversal: something + * referenced but that does not exist in content model + * * @since 2.10 */ public TreeNode missingNode() { @@ -21,6 +24,8 @@ public TreeNode missingNode() { } /** + * @return Node that represents explict {@code null} value in content + * * @since 2.10 */ public TreeNode nullNode() { diff --git a/src/main/java/com/fasterxml/jackson/core/Version.java b/src/main/java/com/fasterxml/jackson/core/Version.java index 02f3de83dc..f53aad29a7 100644 --- a/src/main/java/com/fasterxml/jackson/core/Version.java +++ b/src/main/java/com/fasterxml/jackson/core/Version.java @@ -37,9 +37,13 @@ public class Version protected final String _snapshotInfo; /** - * @deprecated Use variant that takes group and artifact ids - * + * @param major Major version number + * @param minor Minor version number + * @param patchLevel patch level of version + * @param snapshotInfo Optional additional string qualifier + * * @since 2.1 + * @deprecated Use variant that takes group and artifact ids */ @Deprecated public Version(int major, int minor, int patchLevel, String snapshotInfo) @@ -61,10 +65,16 @@ public Version(int major, int minor, int patchLevel, String snapshotInfo, /** * Method returns canonical "not known" version, which is used as version * in cases where actual version information is not known (instead of null). + * + * @return Version instance to use as a placeholder when actual version is not known + * (or not relevant) */ public static Version unknownVersion() { return UNKNOWN_VERSION; } /** + * @return {@code True} if this instance is the one returned by + * call to {@link #unknownVersion()} + * * @since 2.7 to replace misspelled {@link #isUknownVersion()} */ public boolean isUnknownVersion() { return (this == UNKNOWN_VERSION); } @@ -72,6 +82,9 @@ public Version(int major, int minor, int patchLevel, String snapshotInfo, public boolean isSnapshot() { return (_snapshotInfo != null && _snapshotInfo.length() > 0); } /** + * @return {@code True} if this instance is the one returned by + * call to {@link #unknownVersion()} + * * @deprecated Since 2.7 use correctly spelled method {@link #isUnknownVersion()} */ @Deprecated diff --git a/src/main/java/com/fasterxml/jackson/core/util/BufferRecycler.java b/src/main/java/com/fasterxml/jackson/core/util/BufferRecycler.java index 91b07f5dc9..10b81486cb 100644 --- a/src/main/java/com/fasterxml/jackson/core/util/BufferRecycler.java +++ b/src/main/java/com/fasterxml/jackson/core/util/BufferRecycler.java @@ -99,7 +99,10 @@ public BufferRecycler() { /** * Alternate constructor to be used by sub-classes, to allow customization * of number of low-level buffers in use. - * + * + * @param bbCount Number of {@code byte[]} buffers to allocate + * @param cbCount Number of {@code char[]} buffers to allocate + * * @since 2.4 */ protected BufferRecycler(int bbCount, int cbCount) { @@ -115,6 +118,8 @@ protected BufferRecycler(int bbCount, int cbCount) { /** * @param ix One of
READ_IO_BUFFER
constants.
+ *
+ * @return Buffer allocated (possibly recycled)
*/
public final byte[] allocByteBuffer(int ix) {
return allocByteBuffer(ix, 0);
diff --git a/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java b/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java
index 4936ffaeb3..990d6fed04 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/BufferRecyclers.java
@@ -57,6 +57,8 @@ public class BufferRecyclers
/**
* Main accessor to call for accessing possibly recycled {@link BufferRecycler} instance.
+ *
+ * @return {@link BufferRecycler} to use
*/
public static BufferRecycler getBufferRecycler()
{
diff --git a/src/main/java/com/fasterxml/jackson/core/util/ByteArrayBuilder.java b/src/main/java/com/fasterxml/jackson/core/util/ByteArrayBuilder.java
index 51f7b5e928..336301f435 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/ByteArrayBuilder.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/ByteArrayBuilder.java
@@ -82,6 +82,8 @@ public void reset() {
}
/**
+ * @return Number of bytes aggregated so far
+ *
* @since 2.9
*/
public int size() {
@@ -130,9 +132,7 @@ public void appendThreeBytes(int b24) {
}
}
- /**
- * @since 2.9
- */
+ // @since 2.9
public void appendFourBytes(int b32) {
if ((_currBlockPtr + 3) < _currBlock.length) {
_currBlock[_currBlockPtr++] = (byte) (b32 >> 24);
@@ -150,6 +150,8 @@ public void appendFourBytes(int b32) {
/**
* Method called when results are finalized and we can get the
* full aggregated result buffer to return to the caller
+ *
+ * @return Aggregated contents as a {@code byte[]}
*/
public byte[] toByteArray()
{
@@ -187,6 +189,8 @@ public byte[] toByteArray()
/**
* Method called when starting "manual" output: will clear out
* current state and return the first segment buffer to fill
+ *
+ * @return Segment to use for writing
*/
public byte[] resetAndGetFirstSegment() {
reset();
@@ -197,6 +201,8 @@ public byte[] resetAndGetFirstSegment() {
* Method called when the current segment buffer is full; will
* append to current contents, allocate a new segment buffer
* and return it
+ *
+ * @return Segment to use for writing
*/
public byte[] finishCurrentSegment() {
_allocMore();
diff --git a/src/main/java/com/fasterxml/jackson/core/util/DefaultIndenter.java b/src/main/java/com/fasterxml/jackson/core/util/DefaultIndenter.java
index 143a51f1c6..1e9dcdb362 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/DefaultIndenter.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/DefaultIndenter.java
@@ -46,7 +46,10 @@ public DefaultIndenter() {
/**
* Create an indenter which uses the indent
string to indent one level
- * and the eol
string to separate lines.
+ * and the eol
string to separate lines.
+ *
+ * @param indent Indentation String to prepend for a single level of indentation
+ * @param eol End-of-line marker to use after indented line
*/
public DefaultIndenter(String indent, String eol)
{
diff --git a/src/main/java/com/fasterxml/jackson/core/util/DefaultPrettyPrinter.java b/src/main/java/com/fasterxml/jackson/core/util/DefaultPrettyPrinter.java
index 7e8250efaf..32f425ffc7 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/DefaultPrettyPrinter.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/DefaultPrettyPrinter.java
@@ -107,10 +107,8 @@ public DefaultPrettyPrinter() {
*
* Note: simply constructs a {@link SerializedString} out of parameter,
* calls {@link #DefaultPrettyPrinter(SerializableString)}
- *
- * @param rootSeparator
- *
- * @since 2.1
+ *
+ * @param rootSeparator String to use as root value separator
*/
public DefaultPrettyPrinter(String rootSeparator) {
this((rootSeparator == null) ? null : new SerializedString(rootSeparator));
@@ -119,10 +117,8 @@ public DefaultPrettyPrinter(String rootSeparator) {
/**
* Constructor that specifies separator String to use between root values;
* if null, no separator is printed.
- *
- * @param rootSeparator
- *
- * @since 2.1
+ *
+ * @param rootSeparator String to use as root value separator
*/
public DefaultPrettyPrinter(SerializableString rootSeparator) {
_rootSeparator = rootSeparator;
@@ -157,6 +153,10 @@ public DefaultPrettyPrinter withRootSeparator(SerializableString rootSeparator)
}
/**
+ * @param rootSeparator Root-level value separator to use
+ *
+ * @return This pretty-printer instance (for call chaining)
+ *
* @since 2.6
*/
public DefaultPrettyPrinter withRootSeparator(String rootSeparator) {
@@ -171,9 +171,7 @@ public void indentObjectsWith(Indenter i) {
_objectIndenter = (i == null) ? NopIndenter.instance : i;
}
- /**
- * @since 2.3
- */
+ // @since 2.3
public DefaultPrettyPrinter withArrayIndenter(Indenter i) {
if (i == null) {
i = NopIndenter.instance;
@@ -186,9 +184,7 @@ public DefaultPrettyPrinter withArrayIndenter(Indenter i) {
return pp;
}
- /**
- * @since 2.3
- */
+ // @since 2.3
public DefaultPrettyPrinter withObjectIndenter(Indenter i) {
if (i == null) {
i = NopIndenter.instance;
@@ -207,6 +203,8 @@ public DefaultPrettyPrinter withObjectIndenter(Indenter i) {
* does this, it is returned; if not, a new instance will be constructed
* and returned.
*
+ * @return This pretty-printer instance (for call chaining)
+ *
* @since 2.3
*/
public DefaultPrettyPrinter withSpacesInObjectEntries() {
@@ -219,6 +217,8 @@ public DefaultPrettyPrinter withSpacesInObjectEntries() {
* does this, it is returned; if not, a new instance will be constructed
* and returned.
*
+ * @return This pretty-printer instance (for call chaining)
+ *
* @since 2.3
*/
public DefaultPrettyPrinter withoutSpacesInObjectEntries() {
@@ -236,6 +236,12 @@ protected DefaultPrettyPrinter _withSpaces(boolean state)
}
/**
+ * Method for configuring separators for this pretty-printer to use
+ *
+ * @param separators Separator definitions to use
+ *
+ * @return This pretty-printer instance (for call chaining)
+ *
* @since 2.9
*/
public DefaultPrettyPrinter withSeparators(Separators separators) {
diff --git a/src/main/java/com/fasterxml/jackson/core/util/Instantiatable.java b/src/main/java/com/fasterxml/jackson/core/util/Instantiatable.java
index 997293c993..a05871d8ce 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/Instantiatable.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/Instantiatable.java
@@ -19,6 +19,8 @@ public interface InstantiatabledelagateCopyMethod
* and which defines whether copy methods are handled locally (false), or
* delegated to configured
@@ -503,6 +504,8 @@ public void copyCurrentStructure(JsonParser p) throws IOException {
public JsonGenerator getDelegate() { return delegate; }
/**
+ * @return Underlying generator that calls are delegated to
+ *
* @since 2.11
*/
public JsonGenerator delegate() { return delegate; }
diff --git a/src/main/java/com/fasterxml/jackson/core/util/JsonParserDelegate.java b/src/main/java/com/fasterxml/jackson/core/util/JsonParserDelegate.java
index cc62136b19..602c5b8518 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/JsonParserDelegate.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/JsonParserDelegate.java
@@ -257,6 +257,8 @@ public JsonParser skipChildren() throws IOException {
/**
* Accessor for getting the immediate {@link JsonParser} this parser delegates calls to.
*
+ * @return Underlying parser calls are delegated to
+ *
* @since 2.10
*/
public JsonParser delegate() { return delegate; }
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 531adb5757..a49c4b1237 100644
--- a/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java
+++ b/src/main/java/com/fasterxml/jackson/core/util/JsonParserSequence.java
@@ -73,13 +73,20 @@ protected JsonParserSequence(boolean checkForExistingToken, JsonParser[] parsers
}
/**
- * Method that will construct a parser (possibly a sequence) that
+ * Method that will construct a sequence (possibly a sequence) that
* contains all given sub-parsers.
* All parsers given are checked to see if they are sequences: and
* if so, they will be "flattened", that is, contained parsers are
* directly added in a new sequence instead of adding sequences
* within sequences. This is done to minimize delegation depth,
* ideally only having just a single level of delegation.
+ *
+ * @param checkForExistingToken Flag passed to be assigned as
+ * {@link #_checkForExistingToken} for resulting sequence
+ * @param first First parser to traverse
+ * @param second Second parser to traverse
+ *
+ * @return Sequence instance constructed
*/
public static JsonParserSequence createFlattened(boolean checkForExistingToken,
JsonParser first, JsonParser second)
@@ -103,10 +110,6 @@ public static JsonParserSequence createFlattened(boolean checkForExistingToken,
p.toArray(new JsonParser[p.size()]));
}
- /**
- * @deprecated Since 2.8 use {@link #createFlattened(boolean, JsonParser, JsonParser)}
- * instead
- */
@Deprecated // since 2.8
public static JsonParserSequence createFlattened(JsonParser first, JsonParser second) {
return createFlattened(false, first, second);
@@ -195,6 +198,8 @@ public JsonParser skipChildren() throws IOException
* Method that is most useful for debugging or testing;
* returns actual number of underlying parsers sequence
* was constructed with (nor just ones remaining active)
+ *
+ * @return Number of actual underlying parsers this sequence has
*/
public int containedParsersCount() {
return _parsers.length;