Package org.simpleyaml.configuration.comments

Class YamlCommentMapper

java.lang.Object
org.simpleyaml.configuration.comments.YamlCommentMapper
All Implemented Interfaces:
org.simpleyaml.configuration.comments.Commentable
Direct Known Subclasses:
SnakeYamlCommentMapper, YamlCommentReader
public class YamlCommentMapper extends Object implements org.simpleyaml.configuration.comments.Commentable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.simpleyaml.configuration.comments.KeyTree
    keyTree
     
    protected static final Predicate<org.simpleyaml.configuration.comments.KeyTree.Node>
    NO_COMMENTS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    YamlCommentMapper(YamlKeyTree keyTree)
     
     
    YamlCommentMapper(YamlConfigurationOptions options)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    clearNode(org.simpleyaml.configuration.comments.KeyTree.Node node)
     
    protected void
    clearNodeIfNoComments(org.simpleyaml.configuration.comments.KeyTree.Node node)
     
    String
    getComment(String path, org.simpleyaml.configuration.comments.CommentType type)
     
    protected final String
    getComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)
     
    org.simpleyaml.configuration.comments.KeyTree
    getKeyTree()
     
    org.simpleyaml.configuration.comments.KeyTree.Node
    getNode(String path)
     
    protected org.simpleyaml.configuration.comments.KeyTree.Node
    getOrAddNode(String path)
     
    protected org.simpleyaml.configuration.comments.KeyTree.Node
    getPriorityNode(String path)
     
    String
    getRawComment(String path, org.simpleyaml.configuration.comments.CommentType type)
     
    protected final String
    getRawComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)
     
    protected YamlConfigurationOptions
    options()
     
    void
    removeComment(String path, org.simpleyaml.configuration.comments.CommentType type)
     
    protected final void
    removeComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)
     
    void
    setComment(String path, String comment, org.simpleyaml.configuration.comments.CommentType type)
     
    protected final void
    setFormattedComment(org.simpleyaml.configuration.comments.KeyTree.Node node, String comment, org.simpleyaml.configuration.comments.CommentType type)
     
    protected final void
    setRawComment(org.simpleyaml.configuration.comments.KeyTree.Node node, String comment, org.simpleyaml.configuration.comments.CommentType type)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.simpleyaml.configuration.comments.Commentable

    getComment, setComment

  • Field Details

    • keyTree

      protected final org.simpleyaml.configuration.comments.KeyTree keyTree

    • NO_COMMENTS

      protected static final Predicate<org.simpleyaml.configuration.comments.KeyTree.Node> NO_COMMENTS

  • Constructor Details

  • Method Details

    • setComment

      public void setComment(String path, String comment, org.simpleyaml.configuration.comments.CommentType type)
      Specified by:
      setComment in interface org.simpleyaml.configuration.comments.Commentable

    • setFormattedComment

      protected final void setFormattedComment(org.simpleyaml.configuration.comments.KeyTree.Node node, String comment, org.simpleyaml.configuration.comments.CommentType type)

    • setRawComment

      protected final void setRawComment(org.simpleyaml.configuration.comments.KeyTree.Node node, String comment, org.simpleyaml.configuration.comments.CommentType type)

    • getComment

      public String getComment(String path, org.simpleyaml.configuration.comments.CommentType type)
      Specified by:
      getComment in interface org.simpleyaml.configuration.comments.Commentable

    • getComment

      protected final String getComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)

    • getRawComment

      protected final String getRawComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)

    • getRawComment

      public String getRawComment(String path, org.simpleyaml.configuration.comments.CommentType type)

    • removeComment

      public void removeComment(String path, org.simpleyaml.configuration.comments.CommentType type)

    • removeComment

      protected final void removeComment(org.simpleyaml.configuration.comments.KeyTree.Node node, org.simpleyaml.configuration.comments.CommentType type)

    • getKeyTree

      public org.simpleyaml.configuration.comments.KeyTree getKeyTree()

    • options

      protected YamlConfigurationOptions options()

    • getNode

      public org.simpleyaml.configuration.comments.KeyTree.Node getNode(String path)

    • getPriorityNode

      protected org.simpleyaml.configuration.comments.KeyTree.Node getPriorityNode(String path)

    • getOrAddNode

      protected org.simpleyaml.configuration.comments.KeyTree.Node getOrAddNode(String path)

    • clearNodeIfNoComments

      protected void clearNodeIfNoComments(org.simpleyaml.configuration.comments.KeyTree.Node node)

    • clearNode

      protected void clearNode(org.simpleyaml.configuration.comments.KeyTree.Node node)