Skip to content

Commit 2493625

Browse files
committed
Yet more javadoc'ing
1 parent 00a8c72 commit 2493625

9 files changed

+156
-50
lines changed

src/main/java/com/fasterxml/jackson/core/SerializableString.java

+8-8
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,9 @@ public interface SerializableString
157157

158158
/**
159159
* Method for writing JSON-escaped UTF-8 encoded String value using given
160-
* {@link OutputStream}.
160+
* {@link java.io.OutputStream}.
161161
*
162-
* @param out {@link OutputStream} to write String into
162+
* @param out {@link java.io.OutputStream} to write String into
163163
*
164164
* @return Number of bytes written
165165
*
@@ -169,9 +169,9 @@ public interface SerializableString
169169

170170
/**
171171
* Method for writing unescaped UTF-8 encoded String value using given
172-
* {@link OutputStream}.
172+
* {@link java.io.OutputStream}.
173173
*
174-
* @param out {@link OutputStream} to write String into
174+
* @param out {@link java.io.OutputStream} to write String into
175175
*
176176
* @return Number of bytes written
177177
*
@@ -181,9 +181,9 @@ public interface SerializableString
181181

182182
/**
183183
* Method for appending JSON-escaped UTF-8 encoded String value into given
184-
* {@link ByteBuffer}, if it fits.
184+
* {@link java.nio.ByteBuffer}, if it fits.
185185
*
186-
* @param buffer {@link ByteBuffer} to append String into
186+
* @param buffer {@link java.nio.ByteBuffer} to append String into
187187
*
188188
* @return Number of bytes put, if contents fit, otherwise -1
189189
*
@@ -193,9 +193,9 @@ public interface SerializableString
193193

194194
/**
195195
* Method for appending unquoted ('raw') UTF-8 encoded String value into given
196-
* {@link ByteBuffer}, if it fits.
196+
* {@link java.nio.ByteBuffer}, if it fits.
197197
*
198-
* @param buffer {@link ByteBuffer} to append String into
198+
* @param buffer {@link java.nio.ByteBuffer} to append String into
199199
*
200200
* @return Number of bytes put, if contents fit, otherwise -1
201201
*

src/main/java/com/fasterxml/jackson/core/io/InputDecorator.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ public abstract class InputDecorator
2626
*
2727
* @return InputStream to use; either 'in' as is, or decorator
2828
* version that typically delogates to 'in'
29+
*
30+
* @throws IOException if construction of {@link InputStream} fails
2931
*/
3032
public abstract InputStream decorate(IOContext ctxt, InputStream in)
3133
throws IOException;
@@ -46,6 +48,8 @@ public abstract InputStream decorate(IOContext ctxt, InputStream in)
4648
*
4749
* @return Either {@link InputStream} to use as input source; or null to indicate
4850
* that contents are to be processed as-is by caller
51+
*
52+
* @throws IOException if construction of {@link InputStream} fails
4953
*/
5054
public abstract InputStream decorate(IOContext ctxt, byte[] src, int offset, int length)
5155
throws IOException;
@@ -65,7 +69,9 @@ public abstract InputStream decorate(IOContext ctxt, byte[] src, int offset, int
6569
*
6670
* @return InputStream to use; either 'input' as is, or decorator
6771
* version that typically delogates to 'input'
68-
*
72+
*
73+
* @throws IOException if construction of {@link DataInput} fails
74+
*
6975
* @since 2.8
7076
*/
7177
public DataInput decorate(IOContext ctxt, DataInput input)
@@ -86,6 +92,8 @@ public DataInput decorate(IOContext ctxt, DataInput input)
8692
*
8793
* @return Reader to use; either passed in argument, or something that
8894
* calls it (for example, a {@link FilterReader})
95+
*
96+
* @throws IOException if construction of {@link Reader} fails
8997
*/
9098
public abstract Reader decorate(IOContext ctxt, Reader r) throws IOException;
9199
}

src/main/java/com/fasterxml/jackson/core/json/DupDetector.java

+14
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,26 @@ public JsonLocation findLocation() {
6565
}
6666

6767
/**
68+
* @return Source object (parser / generator) used to construct this detector
69+
*
6870
* @since 2.7
6971
*/
7072
public Object getSource() {
7173
return _source;
7274
}
7375

76+
/**
77+
* Method called to check whether a newly encountered property name would
78+
* be a duplicate within this context, and if not, update the state to remember
79+
* having seen the property name for checking more property names
80+
*
81+
* @param name Property seen
82+
*
83+
* @return {@code True} if the property had already been seen before in this context
84+
*
85+
* @throws JsonParseException to report possible operation problem (default implementation
86+
* never throws it)
87+
*/
7488
public boolean isDup(String name) throws JsonParseException
7589
{
7690
if (_firstName == null) {

src/main/java/com/fasterxml/jackson/core/json/JsonReadFeature.java

+2
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,8 @@ public enum JsonReadFeature
196196
/**
197197
* Method that calculates bit set (flags) of all features that
198198
* are enabled by default.
199+
*
200+
* @return Bit mask of all features that are enabled by default
199201
*/
200202
public static int collectDefaults()
201203
{

src/main/java/com/fasterxml/jackson/core/json/JsonWriteFeature.java

+2
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ public enum JsonWriteFeature
108108
/**
109109
* Method that calculates bit set (flags) of all features that
110110
* are enabled by default.
111+
*
112+
* @return Bit mask of all features that are enabled by default
111113
*/
112114
public static int collectDefaults()
113115
{

src/main/java/com/fasterxml/jackson/core/util/JacksonFeatureSet.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ protected JacksonFeatureSet(int bitmask) {
2727
* "Default" factory which will calculate settings based on default-enabled
2828
* status of all features.
2929
*
30-
* @param <F> Self-reference for convenience
30+
* @param <F> Self-reference type for convenience
3131
*
32-
* @param allFeatures Set of all features (enabled or disabled): usually from {@code Enum.values()}
32+
* @param allFeatures Set of all features (enabled or disabled): usually from
33+
* {@code Enum.values()}
3334
*
3435
* @return Feature set instance constructed
3536
*/

src/main/java/com/fasterxml/jackson/core/util/MinimalPrettyPrinter.java

+2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ public void setRootValueSeparator(String sep) {
5656
/**
5757
* @param separators Separator definitions
5858
*
59+
* @return This pretty-printer instance to allow call chaining
60+
*
5961
* @since 2.9
6062
*/
6163
public MinimalPrettyPrinter setSeparators(Separators separators) {

0 commit comments

Comments
 (0)