Package cc.carm.lib.yamlcommentupdater

Class CommentedYAMLWriter

  • public class CommentedYAMLWriter
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static @NotNull java.lang.String SEPARATOR  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      protected static @Nullable java.lang.String buildHeaderComments​(@NotNull CommentedYAML source, @Nullable java.lang.String path, @NotNull java.lang.String indents)  
      protected static java.lang.String buildIndents​(@NotNull java.lang.String key)  
      protected static void writeWithComments​(@NotNull CommentedYAML source, @NotNull java.io.BufferedWriter writer)  
      static void writeWithComments​(@NotNull CommentedYAML source, @NotNull java.io.File file)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • SEPARATOR

        @NotNull
protected static final @NotNull java.lang.String SEPARATOR
        See Also:
        Constant Field Values

    • Constructor Detail

      • CommentedYAMLWriter

        public CommentedYAMLWriter()

    • Method Detail

      • writeWithComments

        public static void writeWithComments​(@NotNull
                                     @NotNull CommentedYAML source,
                                     @NotNull
                                     @NotNull java.io.File file)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • writeWithComments

        protected static void writeWithComments​(@NotNull
                                        @NotNull CommentedYAML source,
                                        @NotNull
                                        @NotNull java.io.BufferedWriter writer)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • buildIndents

        protected static java.lang.String buildIndents​(@NotNull
                                               @NotNull java.lang.String key)

      • buildHeaderComments

        @Nullable
protected static @Nullable java.lang.String buildHeaderComments​(@NotNull
                                                                @NotNull CommentedYAML source,
                                                                @Nullable
                                                                @Nullable java.lang.String path,
                                                                @NotNull
                                                                @NotNull java.lang.String indents)