Annotation Type Comment


  • @Target({FIELD,PARAMETER})
    @Retention(RUNTIME)
    public @interface Comment
    A comment that will be applied to a configuration node if possible.

    By default, this node will not override any user-defined comments.

    When used with an object mapper with a Processor.comments() or Processor.localizedComments(ResourceBundle) processor applied, the comment in value() will be applied to the node upon save.

    Since:
    4.0.0
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The comment to use.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean override
      Whether or not to override existing comments on a node.
    • Element Detail

      • value

        java.lang.String value
        The comment to use.
        Returns:
        comment
        Since:
        4.0.0
      • override

        boolean override
        Whether or not to override existing comments on a node.
        Returns:
        if we should override.
        Since:
        4.0.0
        Default:
        false