java.lang.Object
- java.lang.Enum<ConfigLocator>
- - org.refcodes.runtime.ConfigLocator

All Implemented Interfaces:

Serializable, Comparable<ConfigLocator>
```
public enum ConfigLocator
extends Enum<ConfigLocator>
```
This enumeration represents configuration folder locations (of type File) and configuration file retrieval as of the chosen configuration mode.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ABSOLUTE`	None of the as of the folders as of the `ConfigLocator` enumeration are considered.
`ALL`	Representation of folders as of the `ConfigLocator` enumeration.
`APPLICATION_ALL`	Representation of all the `APPLICATION_*` folders.
`APPLICATION_DIR`	Representation of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_ALL`	Representation of all the `APPLICATION_DIR_*` folders as of the `ConfigLocator` enumeration.
`APPLICATION_DIR_CONFIG`	Representation of the `config` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_DOT_CONFIG`	Representation of the `.config` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_DOT_ETC`	Representation of the `.etc` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_DOT_SETTINGS`	Representation of the `.settings` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_ETC`	Representation of the `etc` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_DIR_SETTINGS`	Representation of the `settings` folder relative to the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_ALL`	Representation of all the `APPLICATION_PARRENT_*` folders as of the `ConfigLocator` enumeration.
`APPLICATION_PARENT_CONFIG`	Representation of the `config` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_DOT_CONFIG`	Representation of the `.config` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_DOT_ETC`	Representation of the `.etc` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_DOT_SETTINGS`	Representation of the `.settings` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_ETC`	Representation of the `etc` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`APPLICATION_PARENT_SETTINGS`	Representation of the `settings` folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
`DEFAULT`	Any of `USER_WORKING_DIRECTORY`, `APPLICATION_DIR`, `APPLICATION_DIR_SETTINGS`, `APPLICATION_DIR_ETC`, `APPLICATION_DIR_CONFIG`, `USER_HOME_DOT_CONFIG` or `HOST_ETC` in this precedence.
`HOST_ETC`	Representation of the (in Unix alike systems) `/etc/` folder.
`USER_HOME`	Representation of the executing user's home folder.
`USER_HOME_ALL`	Representation of all the `USER_HOME_*` folders.
`USER_HOME_CONFIG`	Representation of the `config` folder relative to the executing user's home folder.
`USER_HOME_DOT_CONFIG`	Representation of the `.config` folder relative to the executing user's home folder.
`USER_HOME_DOT_ETC`	Representation of the `.etc` folder relative to the executing user's home folder.
`USER_HOME_DOT_SETTINGS`	Representation of the `.settings` folder relative to the executing user's home folder.
`USER_HOME_ETC`	Representation of the `etc` folder relative to the executing user's home folder.
`USER_HOME_SETTINGS`	Representation of the `settings` folder relative to the executing user's home folder.
`USER_HOME_WORKING_DIRECTORY_ALL`	Representation of all the `USER_HOME_*` folders as well as the current user's current working directory `USER_WORKING_DIRECTORY`.
`USER_WORKING_DIRECTORY`	Consider just the current user's current working directory.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`File[]`	`getFolders()`	Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation.
`File[]`	`getFolders(File... aFolders)`	Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation.
`boolean`	`isApplicationBase()`	Determines whether to consider the application's base (the folder where the JAR resides) folder.
`boolean`	`isApplicationBaseConfig()`	Determines whether to consider the application's base (the folder where the JAR resides) "config" subfolder.
`boolean`	`isApplicationBaseDotConfig()`	Determines whether to consider the application's base (the folder where the JAR resides) ".config" subfolder.
`boolean`	`isApplicationBaseDotEtc()`	Determines whether to consider the application's base (the folder where the JAR resides) ".etc" subfolder.
`boolean`	`isApplicationBaseDotSettings()`	Determines whether to consider the application's base (the folder where the JAR resides) ".settings" subfolder.
`boolean`	`isApplicationBaseEtc()`	Determines whether to consider the application's base (the folder where the JAR resides) "etc" subfolder.
`boolean`	`isApplicationBaseSettings()`	Determines whether to consider the application's base (the folder where the JAR resides) "settings" subfolder.
`boolean`	`isApplicationParentConfig()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "config" subfolder.
`boolean`	`isApplicationParentDotConfig()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".config" subfolder.
`boolean`	`isApplicationParentDotEtc()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".etc" subfolder.
`boolean`	`isApplicationParentDotSettings()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".settings" subfolder.
`boolean`	`isApplicationParentEtc()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "etc" subfolder.
`boolean`	`isApplicationParentSettings()`	Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "settings" subfolder.
`boolean`	`isHostEtc()`	Determines whether to consider the host's "/etc" folder.
`boolean`	`isUserHome()`	Determines whether to consider the user's home "~" folder.
`boolean`	`isUserHomeConfig()`	Determines whether to consider the user's home "~" subfolder "config".
`boolean`	`isUserHomeDotConfig()`	Determines whether to consider the user's home "~" subfolder ".config".
`boolean`	`isUserHomeDotEtc()`	Determines whether to consider the user's home "~" subfolder ".etc".
`boolean`	`isUserHomeDotSettings()`	Determines whether to consider the user's home "~" subfolder ".settings".
`boolean`	`isUserHomeEtc()`	Determines whether to consider the user's home "~" subfolder "etc".
`boolean`	`isUserHomeSettings()`	Determines whether to consider the user's home "~" subfolder "settings".
`boolean`	`isUserWorkingDir()`	Determines whether to consider the user's current working directory (as for example bash's `pwd` would print out).
`File`	`toFile(String aFileName)`	Retrieves the first `File` identified by the given filename located in one of the according enumeration's configuration locations.
`File`	`toFile(String aFileName, File... aFolders)`	Retrieves the first `File` identified by the given filename located in one of the according enumeration's configuration locations.
`static ConfigLocator`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ConfigLocator[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DEFAULT
```
public static final ConfigLocator DEFAULT
```
    Any of USER_WORKING_DIRECTORY, APPLICATION_DIR, APPLICATION_DIR_SETTINGS, APPLICATION_DIR_ETC, APPLICATION_DIR_CONFIG, USER_HOME_DOT_CONFIG or HOST_ETC in this precedence.
  - HOST_ETC
```
public static final ConfigLocator HOST_ETC
```
    Representation of the (in Unix alike systems) /etc/ folder.
  - APPLICATION_DIR
```
public static final ConfigLocator APPLICATION_DIR
```
    Representation of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_CONFIG
```
public static final ConfigLocator APPLICATION_DIR_CONFIG
```
    Representation of the config folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_ETC
```
public static final ConfigLocator APPLICATION_DIR_ETC
```
    Representation of the etc folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_SETTINGS
```
public static final ConfigLocator APPLICATION_DIR_SETTINGS
```
    Representation of the settings folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_DOT_CONFIG
```
public static final ConfigLocator APPLICATION_DIR_DOT_CONFIG
```
    Representation of the .config folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_DOT_ETC
```
public static final ConfigLocator APPLICATION_DIR_DOT_ETC
```
    Representation of the .etc folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_DOT_SETTINGS
```
public static final ConfigLocator APPLICATION_DIR_DOT_SETTINGS
```
    Representation of the .settings folder relative to the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_DIR_ALL
```
public static final ConfigLocator APPLICATION_DIR_ALL
```
    Representation of all the APPLICATION_DIR_* folders as of the ConfigLocator enumeration.
  - APPLICATION_PARENT_CONFIG
```
public static final ConfigLocator APPLICATION_PARENT_CONFIG
```
    Representation of the config folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_ETC
```
public static final ConfigLocator APPLICATION_PARENT_ETC
```
    Representation of the etc folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_SETTINGS
```
public static final ConfigLocator APPLICATION_PARENT_SETTINGS
```
    Representation of the settings folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_DOT_CONFIG
```
public static final ConfigLocator APPLICATION_PARENT_DOT_CONFIG
```
    Representation of the .config folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_DOT_ETC
```
public static final ConfigLocator APPLICATION_PARENT_DOT_ETC
```
    Representation of the .etc folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_DOT_SETTINGS
```
public static final ConfigLocator APPLICATION_PARENT_DOT_SETTINGS
```
    Representation of the .settings folder in the parent directory of the folder in which the application resides (e.g. the `JAR` file).
  - APPLICATION_PARENT_ALL
```
public static final ConfigLocator APPLICATION_PARENT_ALL
```
    Representation of all the APPLICATION_PARRENT_* folders as of the ConfigLocator enumeration.
  - APPLICATION_ALL
```
public static final ConfigLocator APPLICATION_ALL
```
    Representation of all the APPLICATION_* folders.
  - USER_HOME
```
public static final ConfigLocator USER_HOME
```
    Representation of the executing user's home folder.
  - USER_HOME_CONFIG
```
public static final ConfigLocator USER_HOME_CONFIG
```
    Representation of the config folder relative to the executing user's home folder.
  - USER_HOME_ETC
```
public static final ConfigLocator USER_HOME_ETC
```
    Representation of the etc folder relative to the executing user's home folder.
  - USER_HOME_SETTINGS
```
public static final ConfigLocator USER_HOME_SETTINGS
```
    Representation of the settings folder relative to the executing user's home folder.
  - USER_HOME_DOT_CONFIG
```
public static final ConfigLocator USER_HOME_DOT_CONFIG
```
    Representation of the .config folder relative to the executing user's home folder.
  - USER_HOME_DOT_ETC
```
public static final ConfigLocator USER_HOME_DOT_ETC
```
    Representation of the .etc folder relative to the executing user's home folder.
  - USER_HOME_DOT_SETTINGS
```
public static final ConfigLocator USER_HOME_DOT_SETTINGS
```
    Representation of the .settings folder relative to the executing user's home folder.
  - USER_HOME_ALL
```
public static final ConfigLocator USER_HOME_ALL
```
    Representation of all the USER_HOME_* folders.
  - USER_WORKING_DIRECTORY
```
public static final ConfigLocator USER_WORKING_DIRECTORY
```
    Consider just the current user's current working directory.
  - USER_HOME_WORKING_DIRECTORY_ALL
```
public static final ConfigLocator USER_HOME_WORKING_DIRECTORY_ALL
```
    Representation of all the USER_HOME_* folders as well as the current user's current working directory USER_WORKING_DIRECTORY.
  - ALL
```
public static final ConfigLocator ALL
```
    Representation of folders as of the ConfigLocator enumeration.
  - ABSOLUTE
```
public static final ConfigLocator ABSOLUTE
```
    None of the as of the folders as of the ConfigLocator enumeration are considered.
- Method Detail
  - values
```
public static ConfigLocator[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ConfigLocator c : ConfigLocator.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConfigLocator valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isHostEtc
```
public boolean isHostEtc()
```
    Determines whether to consider the host's "/etc" folder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBase
```
public boolean isApplicationBase()
```
    Determines whether to consider the application's base (the folder where the JAR resides) folder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseConfig
```
public boolean isApplicationBaseConfig()
```
    Determines whether to consider the application's base (the folder where the JAR resides) "config" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseEtc
```
public boolean isApplicationBaseEtc()
```
    Determines whether to consider the application's base (the folder where the JAR resides) "etc" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseSettings
```
public boolean isApplicationBaseSettings()
```
    Determines whether to consider the application's base (the folder where the JAR resides) "settings" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseDotConfig
```
public boolean isApplicationBaseDotConfig()
```
    Determines whether to consider the application's base (the folder where the JAR resides) ".config" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseDotEtc
```
public boolean isApplicationBaseDotEtc()
```
    Determines whether to consider the application's base (the folder where the JAR resides) ".etc" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationBaseDotSettings
```
public boolean isApplicationBaseDotSettings()
```
    Determines whether to consider the application's base (the folder where the JAR resides) ".settings" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentConfig
```
public boolean isApplicationParentConfig()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "config" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentEtc
```
public boolean isApplicationParentEtc()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "etc" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentSettings
```
public boolean isApplicationParentSettings()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) "settings" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentDotConfig
```
public boolean isApplicationParentDotConfig()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".config" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentDotEtc
```
public boolean isApplicationParentDotEtc()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".etc" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isApplicationParentDotSettings
```
public boolean isApplicationParentDotSettings()
```
    Determines whether to consider the application's parent (the parent folder of the folder where the JAR resides) ".settings" subfolder.
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHome
```
public boolean isUserHome()
```
    Determines whether to consider the user's home "~" folder.
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeConfig
```
public boolean isUserHomeConfig()
```
    Determines whether to consider the user's home "~" subfolder "config".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeEtc
```
public boolean isUserHomeEtc()
```
    Determines whether to consider the user's home "~" subfolder "etc".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeSettings
```
public boolean isUserHomeSettings()
```
    Determines whether to consider the user's home "~" subfolder "settings".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeDotConfig
```
public boolean isUserHomeDotConfig()
```
    Determines whether to consider the user's home "~" subfolder ".config".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeDotEtc
```
public boolean isUserHomeDotEtc()
```
    Determines whether to consider the user's home "~" subfolder ".etc".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserHomeDotSettings
```
public boolean isUserHomeDotSettings()
```
    Determines whether to consider the user's home "~" subfolder ".settings".
    
    Returns:
    
    True in case the according folder is considered.
  - isUserWorkingDir
```
public boolean isUserWorkingDir()
```
    Determines whether to consider the user's current working directory (as for example bash's pwd would print out).
    
    Returns:
    
    True in case the according folder is considered.
  - toFile
```
public File toFile(String aFileName)
```
    Retrieves the first File identified by the given filename located in one of the according enumeration's configuration locations. If provided, regards the folder as provided by the system property SystemProperty.CONFIG_DIR with highest priority. Also takes build environment folders into account (least highest priority) when the launch folder points to an according build environment (such as maven's "target" folder).
    
    Parameters:
    
    aFileName - The filename for which to determine the according File.
    
    Returns:
    
    The according File or null if none such file was detected.
  - toFile
```
public File toFile(String aFileName,
                   File... aFolders)
```
    Retrieves the first File identified by the given filename located in one of the according enumeration's configuration locations. If provided, regards the folder as provided by the system property SystemProperty.CONFIG_DIR with highest priority. The programmatically provided folders are regarded with second highest priority. Also takes build environment folders into account (least highest priority) when the launch folder points to an according build environment (such as maven's "target" folder).
    
    Parameters:
    
    aFileName - The filename for which to determine the according File.
    
    aFolders - The folders to also take into account.
    
    Returns:
    
    The according File or null if none such file was detected.
  - getFolders
```
public File[] getFolders()
```
    Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation. If provided, regards the folder as provided by the system property SystemProperty.CONFIG_DIR with highest priority. Also takes build environment folders into account (least highest priority) when the launch folder points to an according build environment (such as maven's "target" folder).
    
    Returns:
    
    The folders to be examined.
  - getFolders
```
public File[] getFolders(File... aFolders)
```
    Returns the folders to be examined by the according enumeration's configuration in the order as of evaluation. If provided, regards the folder as provided by the system property SystemProperty.CONFIG_DIR with highest priority. The programmatically provided folders are regarded with second highest priority. Also takes build environment folders into account (least highest priority) when the launch folder points to an according build environment (such as maven's "target" folder).
    
    Parameters:
    
    aFolders - The folders to also take into account.
    
    Returns:
    
    The folders to be examined.

Enum ConfigLocator

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DEFAULT

HOST_ETC

APPLICATION_DIR

APPLICATION_DIR_CONFIG

APPLICATION_DIR_ETC

APPLICATION_DIR_SETTINGS

APPLICATION_DIR_DOT_CONFIG

APPLICATION_DIR_DOT_ETC

APPLICATION_DIR_DOT_SETTINGS

APPLICATION_DIR_ALL

APPLICATION_PARENT_CONFIG

APPLICATION_PARENT_ETC

APPLICATION_PARENT_SETTINGS

APPLICATION_PARENT_DOT_CONFIG

APPLICATION_PARENT_DOT_ETC

APPLICATION_PARENT_DOT_SETTINGS

APPLICATION_PARENT_ALL

APPLICATION_ALL

USER_HOME

USER_HOME_CONFIG

USER_HOME_ETC

USER_HOME_SETTINGS

USER_HOME_DOT_CONFIG

USER_HOME_DOT_ETC

USER_HOME_DOT_SETTINGS

USER_HOME_ALL

USER_WORKING_DIRECTORY

USER_HOME_WORKING_DIRECTORY_ALL

ALL

ABSOLUTE

Method Detail

values

valueOf

isHostEtc

isApplicationBase

isApplicationBaseConfig

isApplicationBaseEtc

isApplicationBaseSettings

isApplicationBaseDotConfig

isApplicationBaseDotEtc

isApplicationBaseDotSettings

isApplicationParentConfig

isApplicationParentEtc

isApplicationParentSettings

isApplicationParentDotConfig

isApplicationParentDotEtc

isApplicationParentDotSettings

isUserHome

isUserHomeConfig

isUserHomeEtc

isUserHomeSettings

isUserHomeDotConfig

isUserHomeDotEtc

isUserHomeDotSettings

isUserWorkingDir

toFile

toFile

getFolders

getFolders