Interface CommentedConfigurationNodeIntermediary<N extends CommentedConfigurationNodeIntermediary<N>>

    • Method Detail

      • comment

        @Nullable String comment()
        Gets the current value for the comment.

        If the comment contains multiple lines, the lines will be split by \n

        Returns:
        the configuration's current comment
        Since:
        4.0.0
      • comment

        N comment​(@Nullable String comment)
        Sets the comment for this configuration node.
        Parameters:
        comment - the comment to set. Line breaks should be represented as LFs (\n)
        Returns:
        this node
        Since:
        4.0.0
      • commentIfAbsent

        N commentIfAbsent​(String comment)
        Set a comment on this node if it does not presently have a comment.

        The provided comment must not be null, because setting a null comment would be a no-op

        Parameters:
        comment - the comment to set. Line breaks should be represented as LFs (\n)
        Returns:
        this node
        Since:
        4.0.0