Class SettingsFileIO


  • public final class SettingsFileIO
    extends java.lang.Object
    Utility class for settings file I/O.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void writeDokkaSettings​(java.io.File rootProject, org.jboss.gm.common.utils.PluginUtils.DokkaVersion dokkaVersion)
      If the DokkaVersion is less than or equal to 0.9.18 then this should inject the appropriate resolutionStrategy into the settings.gradle
      static java.lang.String writeProjectNameIfNeeded​(java.io.File rootDir)
      Writes the project name if needed.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • writeProjectNameIfNeeded

        public static java.lang.String writeProjectNameIfNeeded​(java.io.File rootDir)
                                                         throws java.io.IOException
        Writes the project name if needed.
        Parameters:
        rootDir - the root directory of the settings file
        Returns:
        the new project name
        Throws:
        java.io.IOException - if an error occurs while writing the settings file
      • writeDokkaSettings

        public static void writeDokkaSettings​(java.io.File rootProject,
                                              org.jboss.gm.common.utils.PluginUtils.DokkaVersion dokkaVersion)
                                       throws java.io.IOException
        If the DokkaVersion is less than or equal to 0.9.18 then this should inject the appropriate resolutionStrategy into the settings.gradle
        Parameters:
        rootProject - the root directory
        dokkaVersion - the Dokka plugin version
        Throws:
        java.io.IOException - if an error occurs