Interface FileBasedBuilderProperties<T>
- Type Parameters:
T- the type of the result of all set methods for method chaining
- All Known Subinterfaces:
FileBasedBuilderParameters,HierarchicalBuilderParameters,INIBuilderParameters,PropertiesBuilderParameters,XMLBuilderParameters
- All Known Implementing Classes:
FileBasedBuilderParametersImpl,HierarchicalBuilderParametersImpl,INIBuilderParametersImpl,PropertiesBuilderParametersImpl,XMLBuilderParametersImpl
public interface FileBasedBuilderProperties<T>
Definition of a properties interface for parameters of file-based configurations.
This interface defines a set of properties which can be used to specify the location of a configuration source.
-
Method Summary
Modifier and TypeMethodDescriptionsetBasePath(String path) Sets the base path of the associatedFileHandler.setEncoding(String enc) Sets the encoding of the associatedFileHandler.Sets the location of the associatedFileHandleras aFileobject.setFileName(String name) Sets the file name of the associatedFileHandler.Sets theFileSystemof the associatedFileHandler.setLocationStrategy(FileLocationStrategy strategy) Sets theFileLocationStrategyfor resolving the referenced file.Sets the location of the associatedFileHandleras an absolute file path.Sets the factory for creatingReloadingDetectorobjects.setReloadingRefreshDelay(Long reloadingRefreshDelay) Sets the refresh delay for reloading supportSets the location of the associatedFileHandleras aURLobject.default TsetURL(URL url, URLConnectionOptions urlConnectionOptions) Sets the location of the associatedFileHandleras aURLobject.
-
Method Details
-
setBasePath
Sets the base path of the associatedFileHandler.- Parameters:
path- the base path- Returns:
- a reference to this object for method chaining
-
setEncoding
Sets the encoding of the associatedFileHandler.- Parameters:
enc- the encoding- Returns:
- a reference to this object for method chaining
-
setFile
Sets the location of the associatedFileHandleras aFileobject.- Parameters:
file- theFilelocation- Returns:
- a reference to this object for method chaining
-
setFileName
Sets the file name of the associatedFileHandler.- Parameters:
name- the file name- Returns:
- a reference to this object for method chaining
-
setFileSystem
Sets theFileSystemof the associatedFileHandler.- Parameters:
fs- theFileSystem- Returns:
- a reference to this object for method chaining
-
setLocationStrategy
Sets theFileLocationStrategyfor resolving the referenced file.- Parameters:
strategy- theFileLocationStrategy- Returns:
- a reference to this object for method chaining
-
setPath
Sets the location of the associatedFileHandleras an absolute file path.- Parameters:
path- the path location- Returns:
- a reference to this object for method chaining
-
setReloadingDetectorFactory
Sets the factory for creatingReloadingDetectorobjects. With this method a custom factory for reloading detectors can be installed. Per default, a factory creatingFileHandlerReloadingDetectorobjects is used.- Parameters:
factory- theReloadingDetectorFactory- Returns:
- a reference to this object for method chaining
-
setReloadingRefreshDelay
Sets the refresh delay for reloading support- Parameters:
reloadingRefreshDelay- the refresh delay (in milliseconds)- Returns:
- a reference to this object for method chaining
-
setURL
Sets the location of the associatedFileHandleras aURLobject.- Parameters:
url- theURLlocation- Returns:
- a reference to this object for method chaining
-
setURL
Sets the location of the associatedFileHandleras aURLobject.- Parameters:
url- theURLlocationurlConnectionOptions- options- Returns:
- a reference to this object for method chaining
- Since:
- 2.8.0
-