Module com.github.rvesse.airline

Package com.github.rvesse.airline.parser.aliases

Class UserAliasesSource<C>

java.lang.Object

com.github.rvesse.airline.parser.aliases.UserAliasesSource<C>

Type Parameters:

C - Command type

public class UserAliasesSource<C>
extends Object

Represents the source of user defined aliases

Author:

rvesse

Field Summary

Fields

Modifier and Type	Field	Description
static final ResourceLocator[]	DEFAULT_LOCATORS	Default user alias source locators

Constructor Summary

Constructors

Constructor	Description
UserAliasesSource(String filename, String prefix, String... searchLocations)
UserAliasesSource(String filename, String prefix, List<ResourceLocator> locators, List<String> searchLocations)

Method Summary

Modifier and Type	Method	Description
String	getFilename()	Gets the filename of the configuration file that will be scanned for alias definitions
List<ResourceLocator>	getLocators()	Gets the locators that are used to resolve search locations to actual usable locations
String	getPrefix()	Gets the prefix that is used to distinguish alias definitions from other property definitions in the configuration file
List<String>	getSearchLocations()	Gets the search locations where the configuration file may be located in order of preference
List<AliasMetadata>	load()	Loads the alias metadata based on the configured sources

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOCATORS

public static final ResourceLocator[] DEFAULT_LOCATORS

Default user alias source locators

Constructor Details

UserAliasesSource

public UserAliasesSource(String filename,
 String prefix,
 String... searchLocations)

UserAliasesSource

public UserAliasesSource(String filename,
 String prefix,
 List<ResourceLocator> locators,
 List<String> searchLocations)

Method Details

getFilename

public String getFilename()

Gets the filename of the configuration file that will be scanned for alias definitions

Returns:

Configuration file name

getSearchLocations

public List<String> getSearchLocations()

Gets the search locations where the configuration file may be located in order of preference

Returns:

Search locations in order of preference

getPrefix

public String getPrefix()

Gets the prefix that is used to distinguish alias definitions from other property definitions in the configuration file

If this is null/empty/blank then no prefix is in effect

Returns:

Prefix

getLocators

public List<ResourceLocator> getLocators()

Gets the locators that are used to resolve search locations to actual usable locations

Returns:

User alias locators

load

public List<AliasMetadata> load()
                         throws FileNotFoundException,
IOException

Loads the alias metadata based on the configured sources

Returns:

Alias metadata

Throws:

FileNotFoundException - Thrown if unable to find a properties file

IOException - Thrown if unable to read a properties file