Skip to content

Commit 1eb628f

Browse files
committed
Minor javadoc improvements
1 parent e137272 commit 1eb628f

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class AvroGenerator extends GeneratorBase
2121
public enum Feature
2222
implements FormatFeature // since 2.7
2323
{
24-
// !!! TODO: remove from 2.8
24+
// !!! TODO: remove from 2.9
2525
/**
2626
* Feature that can be enabled to quietly ignore serialization of properties
2727
* that can not be mapped to output schema: if enabled, trying to output
@@ -42,6 +42,8 @@ public enum Feature
4242
* Feature that can be disabled to prevent Avro from buffering any more
4343
* data then absolutely necessary.
4444
* This affects buffering by underlying codec.
45+
* Note that disabling buffer is likely to reduce performance if the underlying
46+
* input/output is unbuffered.
4547
*<p>
4648
* Enabled by default to preserve the existing behavior.
4749
*
@@ -357,13 +359,13 @@ public void close() throws IOException
357359
/* Public API: structural output
358360
/**********************************************************
359361
*/
360-
362+
361363
@Override
362364
public final void writeStartArray() throws IOException {
363365
_avroContext = _avroContext.createChildArrayContext();
364366
_complete = false;
365367
}
366-
368+
367369
@Override
368370
public final void writeEndArray() throws IOException
369371
{

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ public AvroFactory getFactory() {
5252
}
5353

5454
/**
55+
* Factory method for constructing {@link AvroSchema} by introspecting given
56+
* POJO type and building schema that contains specified properties.
57+
*<p>
58+
* Resulting schema object does not use separate reader/writer schemas.
59+
*
5560
* @since 2.5
5661
*/
5762
public AvroSchema schemaFor(Class<?> type) throws JsonMappingException
@@ -62,6 +67,11 @@ public AvroSchema schemaFor(Class<?> type) throws JsonMappingException
6267
}
6368

6469
/**
70+
* Factory method for constructing {@link AvroSchema} by introspecting given
71+
* POJO type and building schema that contains specified properties.
72+
*<p>
73+
* Resulting schema object does not use separate reader/writer schemas.
74+
*
6575
* @since 2.5
6676
*/
6777
public AvroSchema schemaFor(JavaType type) throws JsonMappingException
@@ -74,6 +84,8 @@ public AvroSchema schemaFor(JavaType type) throws JsonMappingException
7484
/**
7585
* Method for reading an Avro Schema from given {@link InputStream},
7686
* and once done (successfully or not), closing the stream.
87+
*<p>
88+
* Resulting schema object does not use separate reader/writer schemas.
7789
*
7890
* @since 2.6
7991
*/
@@ -90,6 +102,8 @@ public AvroSchema schemaFrom(InputStream in) throws IOException
90102
/**
91103
* Convenience method for reading {@link AvroSchema} from given
92104
* encoded JSON representation.
105+
*<p>
106+
* Resulting schema object does not use separate reader/writer schemas.
93107
*
94108
* @since 2.6
95109
*/
@@ -102,6 +116,8 @@ public AvroSchema schemaFrom(String schemaAsString) throws IOException
102116
/**
103117
* Convenience method for reading {@link AvroSchema} from given
104118
* encoded JSON representation.
119+
*<p>
120+
* Resulting schema object does not use separate reader/writer schemas.
105121
*
106122
* @since 2.6
107123
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public static BinaryEncoder encoder(OutputStream out, boolean buffering)
8484
BinaryEncoder prev = (ref == null) ? null : ref.get();
8585
/* Factory will check if the encoder has a matching type for reuse.
8686
* If not, it will drop the instance being reused and will return
87-
* a new, proper one.
87+
* a new, properly initialized instance
8888
*/
8989
BinaryEncoder next =
9090
buffering

0 commit comments

Comments
 (0)