Skip to content

Commit

Permalink
Improve JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
JooHyukKim committed Apr 24, 2023
1 parent 7a86901 commit ae0d9f6
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions src/main/java/com/fasterxml/jackson/annotation/JsonTypeInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ public enum As {
*
* @since 2.5
public boolean skipWritingDefault() default false;
/*
*/

/*
/**********************************************************
Expand All @@ -333,18 +333,19 @@ public enum As {
public abstract static class None {}

/**
* Determines whether strict type ID handling should be used for this type or not. This is per-type configuration of
* {@code MapperFeature#REQUIRE_TYPE_ID_FOR_SUBTYPES} and will <strong>always</strong>
* override the global configuration.
* Specifies whether the type ID should be strictly required during polymorphic deserialization of its subtypes.
* <p>
* If set to {@link OptBoolean#TRUE}, an {@code InvalidTypeIdException} will be thrown if no type
* information is provided.
* If set to {@link OptBoolean#FALSE}, deserialization may proceed without type information if the
* subtype is a legitimate target (non-abstract).
* If set to {@link OptBoolean#DEFAULT}, the global configuration of
* {@code MapperFeature#REQUIRE_TYPE_ID_FOR_SUBTYPES} is used for type ID handling.
* <p>
* If set to {@link OptBoolean#TRUE}, then {@code InvalidTypeIdException} will be thrown if no type information
* is provided during polymorphic deserialization for this type;
* if set to {@link OptBoolean#FALSE}, then the deserialization may proceed without the type information assuming
* sub-type is a legitimate target (non-abstract);
* if set to {@link OptBoolean#DEFAULT}, then global configuration of
* {@code MapperFeature.REQUIRE_TYPE_ID_FOR_SUBTYPES} is used for type id handling.
* NOTE: This setting is specific to this type and will <strong>always override</strong> the global
* configuration of {@code MapperFeature#REQUIRE_TYPE_ID_FOR_SUBTYPES}.
*
* @since 2.16
*/
OptBoolean requireTypeIdForSubtypes() default OptBoolean.DEFAULT;
public OptBoolean requireTypeIdForSubtypes() default OptBoolean.DEFAULT;
}

0 comments on commit ae0d9f6

Please sign in to comment.