Uses of Class
org.apache.commons.configuration2.io.FileLocator

Packages that use FileLocator

Package	Description
org.apache.commons.configuration2	The Configuration main package.
org.apache.commons.configuration2.io	A package with classes related to I/O operations.
org.apache.commons.configuration2.plist	Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.

Uses of FileLocator in org.apache.commons.configuration2

Fields in org.apache.commons.configuration2 declared as FileLocator

Modifier and Type	Field	Description
private FileLocator	PropertiesConfiguration.locator	The current FileLocator.
private FileLocator	XMLConfiguration.locator	The current file locator.
private FileLocator	XMLPropertiesConfiguration.locator	The temporary file locator.

Methods in org.apache.commons.configuration2 with parameters of type FileLocator

Modifier and Type	Method	Description
void	PropertiesConfiguration.initFileLocator(FileLocator locator)	Stores the current FileLocator for a following IO operation.
void	XMLConfiguration.initFileLocator(FileLocator loc)	Passes the current FileLocator to this object.
void	XMLPropertiesConfiguration.initFileLocator(FileLocator locator)	Initializes this object with a FileLocator.

Uses of FileLocator in org.apache.commons.configuration2.io

Fields in org.apache.commons.configuration2.io with type parameters of type FileLocator

Modifier and Type	Field	Description
private final AtomicReference<FileLocator>	FileHandler.fileLocator	A reference to the current FileLocator object.

Methods in org.apache.commons.configuration2.io that return FileLocator

Modifier and Type	Method	Description
private FileLocator	FileHandler.checkContentAndGetLocator()	Checks whether a content object is available and returns the current FileLocator.
FileLocator	FileLocator.FileLocatorBuilder.create()	Creates a new immutable FileLocatorImpl object based on the properties set so far for this builder.
private static FileLocator	FileLocatorUtils.createFullyInitializedLocatorFromURL(FileLocator src, URL url)	Creates a fully initialized FileLocator based on the specified URL.
private FileLocator	FileHandler.createLocatorWithFileName(String fileName, FileLocator locator)	Creates a FileLocator which is a copy of the passed in one, but has the given file name set to reference the target file.
private static FileLocator	FileHandler.emptyFileLocator()	Creates an uninitialized file locator.
static FileLocator	FileLocatorUtils.fromMap(Map<String,?> map)	Creates a new FileLocator object with the properties defined in the given map.
static FileLocator	FileLocatorUtils.fullyInitializedLocator(FileLocator locator)	Returns a FileLocator object based on the passed in one whose location is fully defined.
FileLocator	FileHandler.getFileLocator()	Gets a FileLocator object with the specification of the file stored by this FileHandler.

Methods in org.apache.commons.configuration2.io with parameters of type FileLocator

Modifier and Type	Method	Description
private static File	FileHandler.createFile(FileLocator loc)	Creates a File object from the content of the given FileLocator object.
private static FileLocator	FileLocatorUtils.createFullyInitializedLocatorFromURL(FileLocator src, URL url)	Creates a fully initialized FileLocator based on the specified URL.
private FileLocator	FileHandler.createLocatorWithFileName(String fileName, FileLocator locator)	Creates a FileLocator which is a copy of the passed in one, but has the given file name set to reference the target file.
private String	HomeDirectoryLocationStrategy.fetchBasePath(FileLocator locator)	Determines the base path to be used for the current locate() operation.
static FileLocator.FileLocatorBuilder	FileLocatorUtils.fileLocator(FileLocator src)	Returns a FileLocatorBuilder which is already initialized with the properties of the passed in FileLocator.
static FileLocator	FileLocatorUtils.fullyInitializedLocator(FileLocator locator)	Returns a FileLocator object based on the passed in one whose location is fully defined.
(package private) static FileSystem	FileLocatorUtils.getFileSystem(FileLocator locator)	Obtains a non-null FileSystem object from the passed in FileLocator.
(package private) static FileLocationStrategy	FileLocatorUtils.getLocationStrategy(FileLocator locator)	Gets a non null FileLocationStrategy object from the passed in FileLocator.
private void	FileLocator.FileLocatorBuilder.initBuilder(FileLocator src)	Initializes the properties of this builder from the passed in locator object.
void	FileLocatorAware.initFileLocator(FileLocator locator)	Passes the current FileLocator to this object.
static boolean	FileLocatorUtils.isFullyInitialized(FileLocator locator)	Returns a flag whether all components of the given FileLocator describing the referenced file are defined.
static boolean	FileLocatorUtils.isLocationDefined(FileLocator locator)	Checks whether the specified FileLocator contains enough information to locate a file.
private void	FileHandler.load(InputStream in, FileLocator locator)	Internal helper method for loading a file from the given input stream.
private void	FileHandler.load(String fileName, FileLocator locator)	Internal helper method for loading a file from a file name.
private void	FileHandler.load(URL url, FileLocator locator)	Internal helper method for loading a file from the given URL.
private void	FileHandler.load(FileLocator locator)	Internal helper method for loading the associated file from the location specified in the given FileLocator.
URL	AbsoluteNameLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	BasePathLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	ClasspathLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	CombinedLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	FileLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
static URL	FileLocatorUtils.locate(FileLocator locator)	Locates the provided FileLocator, returning a URL for accessing the referenced file.
URL	FileSystemLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	HomeDirectoryLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
URL	ProvidedURLLocationStrategy.locate(FileSystem fileSystem, FileLocator locator)	Tries to locate the specified file.
static URL	FileLocatorUtils.locateOrThrow(FileLocator locator)	Tries to locate the file referenced by the passed in FileLocator.
static void	FileLocatorUtils.put(FileLocator locator, Map<String,Object> map)	Stores the specified FileLocator in the given map.
private void	FileHandler.save(File file, FileLocator locator)	Internal helper method for saving data to the given File.
private void	FileHandler.save(OutputStream out, FileLocator locator)	Internal helper method for saving a file to the given output stream.
private void	FileHandler.save(String fileName, FileLocator locator)	Internal helper method for saving data to the given file name.
private void	FileHandler.save(URL url, FileLocator locator)	Internal helper method for saving data to the given URL.
private void	FileHandler.save(FileLocator locator)	Internal helper method for saving data to the internal location stored for this object.
void	FileHandler.setFileLocator(FileLocator locator)	Sets the file to be accessed by this FileHandler as a FileLocator object.

Constructors in org.apache.commons.configuration2.io with parameters of type FileLocator

Modifier	Constructor	Description
private	FileHandler(FileBased obj, FileLocator locator)	Creates a new instance of FileHandler based on the given FileBased and FileLocator objects.
(package private)	FileLocatorBuilder(FileLocator src)	Creates a new instance of FileLocatorBuilder and initializes the builder's properties from the passed in FileLocator object.

Uses of FileLocator in org.apache.commons.configuration2.plist

Fields in org.apache.commons.configuration2.plist declared as FileLocator

Modifier and Type	Field	Description
private FileLocator	XMLPropertyListConfiguration.locator	Temporarily stores the current file location.

Methods in org.apache.commons.configuration2.plist with parameters of type FileLocator

Modifier and Type	Method	Description
void	XMLPropertyListConfiguration.initFileLocator(FileLocator locator)	Stores the current file locator.