Package org.jline.builtins

Class ConfigurationPath

  • public class ConfigurationPath
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.nio.file.Path appConfig  
      private java.nio.file.Path userConfig  

    • Constructor Summary

      Constructors 
      Constructor Description
      ConfigurationPath​(java.nio.file.Path appConfig, java.nio.file.Path userConfig)
      Configuration class constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.nio.file.Path getConfig​(java.lang.String name)
      Search configuration file first from userConfig and then appConfig directory.
      java.nio.file.Path getUserConfig​(java.lang.String name)
      Search configuration file from userConfig directory.
      java.nio.file.Path getUserConfig​(java.lang.String name, boolean create)
      Search configuration file from userConfig directory.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • appConfig

        private java.nio.file.Path appConfig

      • userConfig

        private java.nio.file.Path userConfig

    • Constructor Detail

      • ConfigurationPath

        public ConfigurationPath​(java.nio.file.Path appConfig,
                         java.nio.file.Path userConfig)
        Configuration class constructor.
        Parameters:
        appConfig - Application configuration directory
        userConfig - User private configuration directory

    • Method Detail

      • getConfig

        public java.nio.file.Path getConfig​(java.lang.String name)
        Search configuration file first from userConfig and then appConfig directory. Returns null if file is not found.
        Parameters:
        name - Configuration file name.
        Returns:
        Configuration file.

      • getUserConfig

        public java.nio.file.Path getUserConfig​(java.lang.String name)
                                 throws java.io.IOException
        Search configuration file from userConfig directory. Returns null if file is not found.
        Parameters:
        name - Configuration file name.
        Returns:
        Configuration file.
        Throws:
        java.io.IOException - When we do not have read access to the file or directory.

      • getUserConfig

        public java.nio.file.Path getUserConfig​(java.lang.String name,
                                        boolean create)
                                 throws java.io.IOException
        Search configuration file from userConfig directory. Returns null if file is not found.
        Parameters:
        name - Configuration file name
        create - When true configuration file is created if not found.
        Returns:
        Configuration file.
        Throws:
        java.io.IOException - When we do not have read/write access to the file or directory.