Uses of Class
org.apache.commons.configuration2.io.FileLocator
Packages that use FileLocator
Package
Description
The Configuration main package.
A package with classes related to I/O operations.
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
-
Uses of FileLocator in org.apache.commons.configuration2
Fields in org.apache.commons.configuration2 declared as FileLocatorModifier and TypeFieldDescriptionprivate FileLocator
PropertiesConfiguration.locator
The currentFileLocator
.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 FileLocatorModifier and TypeMethodDescriptionvoid
PropertiesConfiguration.initFileLocator
(FileLocator locator) Stores the currentFileLocator
for a following IO operation.void
XMLConfiguration.initFileLocator
(FileLocator loc) Passes the currentFileLocator
to this object.void
XMLPropertiesConfiguration.initFileLocator
(FileLocator locator) Initializes this object with aFileLocator
. -
Uses of FileLocator in org.apache.commons.configuration2.io
Fields in org.apache.commons.configuration2.io with type parameters of type FileLocatorModifier and TypeFieldDescriptionprivate final AtomicReference
<FileLocator> FileHandler.fileLocator
A reference to the currentFileLocator
object.Methods in org.apache.commons.configuration2.io that return FileLocatorModifier and TypeMethodDescriptionprivate FileLocator
FileHandler.checkContentAndGetLocator()
Checks whether a content object is available and returns the currentFileLocator
.FileLocator.FileLocatorBuilder.create()
Creates a new immutableFileLocatorImpl
object based on the properties set so far for this builder.private static FileLocator
FileLocatorUtils.createFullyInitializedLocatorFromURL
(FileLocator src, URL url) Creates a fully initializedFileLocator
based on the specified URL.private FileLocator
FileHandler.createLocatorWithFileName
(String fileName, FileLocator locator) Creates aFileLocator
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
Creates a newFileLocator
object with the properties defined in the given map.static FileLocator
FileLocatorUtils.fullyInitializedLocator
(FileLocator locator) Returns aFileLocator
object based on the passed in one whose location is fully defined.FileHandler.getFileLocator()
Gets aFileLocator
object with the specification of the file stored by thisFileHandler
.Methods in org.apache.commons.configuration2.io with parameters of type FileLocatorModifier and TypeMethodDescriptionprivate static File
FileHandler.createFile
(FileLocator loc) Creates aFile
object from the content of the givenFileLocator
object.private static FileLocator
FileLocatorUtils.createFullyInitializedLocatorFromURL
(FileLocator src, URL url) Creates a fully initializedFileLocator
based on the specified URL.private FileLocator
FileHandler.createLocatorWithFileName
(String fileName, FileLocator locator) Creates aFileLocator
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.FileLocatorUtils.fileLocator
(FileLocator src) Returns aFileLocatorBuilder
which is already initialized with the properties of the passed inFileLocator
.static FileLocator
FileLocatorUtils.fullyInitializedLocator
(FileLocator locator) Returns aFileLocator
object based on the passed in one whose location is fully defined.(package private) static FileSystem
FileLocatorUtils.getFileSystem
(FileLocator locator) Obtains a non-nullFileSystem
object from the passed inFileLocator
.(package private) static FileLocationStrategy
FileLocatorUtils.getLocationStrategy
(FileLocator locator) Gets a non nullFileLocationStrategy
object from the passed inFileLocator
.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 currentFileLocator
to this object.static boolean
FileLocatorUtils.isFullyInitialized
(FileLocator locator) Returns a flag whether all components of the givenFileLocator
describing the referenced file are defined.static boolean
FileLocatorUtils.isLocationDefined
(FileLocator locator) Checks whether the specifiedFileLocator
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 givenFileLocator
.AbsoluteNameLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.BasePathLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.ClasspathLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.CombinedLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.FileLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.static URL
FileLocatorUtils.locate
(FileLocator locator) Locates the providedFileLocator
, returning a URL for accessing the referenced file.FileSystemLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.HomeDirectoryLocationStrategy.locate
(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.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 inFileLocator
.static void
FileLocatorUtils.put
(FileLocator locator, Map<String, Object> map) Stores the specifiedFileLocator
in the given map.private void
FileHandler.save
(File file, FileLocator locator) Internal helper method for saving data to the givenFile
.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 thisFileHandler
as aFileLocator
object.Constructors in org.apache.commons.configuration2.io with parameters of type FileLocatorModifierConstructorDescriptionprivate
FileHandler
(FileBased obj, FileLocator locator) Creates a new instance ofFileHandler
based on the givenFileBased
andFileLocator
objects.(package private)
Creates a new instance ofFileLocatorBuilder
and initializes the builder's properties from the passed inFileLocator
object. -
Uses of FileLocator in org.apache.commons.configuration2.plist
Fields in org.apache.commons.configuration2.plist declared as FileLocatorModifier and TypeFieldDescriptionprivate FileLocator
XMLPropertyListConfiguration.locator
Temporarily stores the current file location.Methods in org.apache.commons.configuration2.plist with parameters of type FileLocatorModifier and TypeMethodDescriptionvoid
XMLPropertyListConfiguration.initFileLocator
(FileLocator locator) Stores the current file locator.