Class DirConfigSource

    • Constructor Summary

      Constructors 
      Constructor Description
      DirConfigSource​(java.lang.String id, java.nio.file.Path dir, int weight, boolean canHaveArgs)
      Create DirConfigSource with specified identifier and directory.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      RawArgs getArgs()
      The list of Arguments for this ConfigSource
      java.nio.file.Path getDir()  
      java.lang.String getId()
      The identifier for this source.
      java.lang.String getProperty​(java.lang.String key)
      Return the value of the specified property.
      Props getProps()
      The properties for this ConfigSource
      java.util.Set<StartIni> getStartInis()  
      int getWeight()
      The weight of this source, used for proper ordering of the config source search order.
      int hashCode()  
      boolean isPropertyBased()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DirConfigSource

        public DirConfigSource​(java.lang.String id,
                               java.nio.file.Path dir,
                               int weight,
                               boolean canHaveArgs)
                        throws java.io.IOException
        Create DirConfigSource with specified identifier and directory.
        Parameters:
        id - the identifier for this ConfigSource
        dir - the directory for this ConfigSource
        weight - the configuration weight (used for search order)
        canHaveArgs - true if this directory can have start.ini or start.d entries. (false for directories like ${jetty.home}, for example)
        Throws:
        java.io.IOException - if unable to load the configuration args
    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • getArgs

        public RawArgs getArgs()
        Description copied from interface: ConfigSource
        The list of Arguments for this ConfigSource
        Specified by:
        getArgs in interface ConfigSource
        Returns:
        the list of Arguments for this ConfigSource
      • getDir

        public java.nio.file.Path getDir()
      • getId

        public java.lang.String getId()
        Description copied from interface: ConfigSource
        The identifier for this source.

        Used in end-user display of the source.

        Specified by:
        getId in interface ConfigSource
        Returns:
        the configuration source identifier.
      • getProperty

        public java.lang.String getProperty​(java.lang.String key)
        Description copied from interface: ConfigSource
        Return the value of the specified property.
        Specified by:
        getProperty in interface ConfigSource
        Parameters:
        key - the key to lookup
        Returns:
        the value of the property, or null if not found
      • getProps

        public Props getProps()
        Description copied from interface: ConfigSource
        The properties for this ConfigSource
        Specified by:
        getProps in interface ConfigSource
        Returns:
        the properties for this ConfigSource
      • getWeight

        public int getWeight()
        Description copied from interface: ConfigSource
        The weight of this source, used for proper ordering of the config source search order.

        Recommended Weights:

                   -1 = the command line
                    0 = the ${jetty.base} source
               [1..n] = include-jetty-dir entries from command line
             [n+1..n] = include-jetty-dir entries from start.ini (or start.d/*.ini)
              9999999 = the ${jetty.home} source
         
        Specified by:
        getWeight in interface ConfigSource
        Returns:
        the weight of the config source. (lower value is more important)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • isPropertyBased

        public boolean isPropertyBased()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object