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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description TsetBasePath(String path)Sets the base path of the associatedFileHandler.TsetEncoding(String enc)Sets the encoding of the associatedFileHandler.TsetFile(File file)Sets the location of the associatedFileHandleras aFileobject.TsetFileName(String name)Sets the file name of the associatedFileHandler.TsetFileSystem(FileSystem fs)Sets theFileSystemof the associatedFileHandler.TsetLocationStrategy(FileLocationStrategy strategy)Sets theFileLocationStrategyfor resolving the referenced file.TsetPath(String path)Sets the location of the associatedFileHandleras an absolute file path.TsetReloadingDetectorFactory(ReloadingDetectorFactory factory)Sets the factory for creatingReloadingDetectorobjects.TsetReloadingRefreshDelay(Long reloadingRefreshDelay)Sets the refresh delay for reloading supportTsetURL(URL url)Sets the location of the associatedFileHandleras aURLobject.default TsetURL(URL url, URLConnectionOptions urlConnectionOptions)Sets the location of the associatedFileHandleras aURLobject.
-
-
-
Method Detail
-
setBasePath
T setBasePath(String path)
Sets the base path of the associatedFileHandler.- Parameters:
path- the base path- Returns:
- a reference to this object for method chaining
-
setEncoding
T setEncoding(String enc)
Sets the encoding of the associatedFileHandler.- Parameters:
enc- the encoding- Returns:
- a reference to this object for method chaining
-
setFile
T setFile(File file)
Sets the location of the associatedFileHandleras aFileobject.- Parameters:
file- theFilelocation- Returns:
- a reference to this object for method chaining
-
setFileName
T setFileName(String name)
Sets the file name of the associatedFileHandler.- Parameters:
name- the file name- Returns:
- a reference to this object for method chaining
-
setFileSystem
T setFileSystem(FileSystem fs)
Sets theFileSystemof the associatedFileHandler.- Parameters:
fs- theFileSystem- Returns:
- a reference to this object for method chaining
-
setLocationStrategy
T setLocationStrategy(FileLocationStrategy strategy)
Sets theFileLocationStrategyfor resolving the referenced file.- Parameters:
strategy- theFileLocationStrategy- Returns:
- a reference to this object for method chaining
-
setPath
T setPath(String path)
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
T setReloadingDetectorFactory(ReloadingDetectorFactory factory)
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
T setReloadingRefreshDelay(Long reloadingRefreshDelay)
Sets the refresh delay for reloading support- Parameters:
reloadingRefreshDelay- the refresh delay (in milliseconds)- Returns:
- a reference to this object for method chaining
-
setURL
T setURL(URL url)
Sets the location of the associatedFileHandleras aURLobject.- Parameters:
url- theURLlocation- Returns:
- a reference to this object for method chaining
-
setURL
default T setURL(URL url, URLConnectionOptions urlConnectionOptions)
Sets the location of the associatedFileHandleras aURLobject.- Parameters:
url- theURLlocationurlConnectionOptions- options- Returns:
- a reference to this object for method chaining
- Since:
- 2.8.0
-
-