Skip to content

Commit 61394ab

Browse files
committed
update javadocs
1 parent b6fc327 commit 61394ab

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

slack-api-model/src/main/java/com/slack/api/util/json/RequiredAdapterFactory.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@
1313
import java.io.IOException;
1414

1515
/**
16-
* Adapter factory for processing objects annotated with our custom annotation {@link Required}.
16+
* Adapter factory for processing objects annotated with {@link Required}. This annotation signals what properties
17+
* of a model object are required, and thus should be expected to be initialized and non-null on every instance of
18+
* said object.
1719
* <p>
1820
* For deserialization (e.g. converting JSON --> POJO), it ensures that any fields marked as {@link Required} are
1921
* present in the constructed object and nonnull.
2022
* <p>
21-
* For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are
22-
* non-null and written to the JSON string.
23+
* For serialization (e.g. converting POJO --> JSON), it ensures that any fields marked as {@link Required} are non-null
24+
* in the construct object prior to serialization.
2325
*/
2426
public class RequiredAdapterFactory implements TypeAdapterFactory {
2527
@Override

0 commit comments

Comments
 (0)