Package org.apache.juneau.json.annotation

Annotation Type JsonConfig

@Target({TYPE,METHOD}) @Retention(RUNTIME) @Inherited @ContextApply({SerializerApply.class,ParserApply.class}) public @interface JsonConfig
Annotation for specifying config properties defined in JsonSerializer and JsonParser.

Used primarily for specifying bean configuration properties on REST classes and methods.

See Also:

  • Element Details

    • rank

      int rank
      Optional rank for this config.

      Can be used to override default ordering and application of config annotations.

      Returns:
      The annotation value.
      Default:
      0

    • validateEnd

      String validateEnd
      Validate end.

      If "true", after parsing a POJO from the input, verifies that the remaining input in the stream consists of only comments or whitespace.

      • "true"
      • "false" (default)
      Notes:
      See Also:
      Returns:
      The annotation value.
      Default:
      ""

    • addBeanTypes

      String addBeanTypes
      Add "_type" properties when needed.

      If "true", then "_type" properties will be added to beans if their type cannot be inferred through reflection.

      When present, this value overrides the Serializer.Builder.addBeanTypes() setting and is provided to customize the behavior of specific serializers in a SerializerSet.

      • "true"
      • "false" (default)
      Notes:
      See Also:
      Returns:
      The annotation value.
      Default:
      ""

    • escapeSolidus

      String escapeSolidus
      Prefix solidus '/' characters with escapes.

      If "true", solidus (e.g. slash) characters should be escaped. The JSON specification allows for either format.
      However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to serialize <\/script>.

      • "true"
      • "false" (default)
      Notes:
      See Also:
      Returns:
      The annotation value.
      Default:
      ""

    • simpleAttrs

      String simpleAttrs
      Simple JSON attribute mode.

      If "true", JSON attribute names will only be quoted when necessary.
      Otherwise, they are always quoted.

      Attributes do not need to be quoted when they conform to the following:

      1. They start with an ASCII character or '_'.
      2. They contain only ASCII characters or numbers or '_'.
      3. They are not one of the following reserved words:

        arguments, break, case, catch, class, const, continue, debugger, default, delete, do, else, enum, eval, export, extends, false, finally, for, function, if, implements, import, in, instanceof, interface, let, new, null, package, private, protected, public, return, static, super, switch, this, throw, true, try, typeof, var, void, while, with, undefined, yield

      • "true"
      • "false" (default)
      Notes:
      See Also:
      Returns:
      The annotation value.
      Default:
      ""