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 T
setBasePath(java.lang.String path)
Sets the base path of the associatedFileHandler
.T
setEncoding(java.lang.String enc)
Sets the encoding of the associatedFileHandler
.T
setFile(java.io.File file)
Sets the location of the associatedFileHandler
as aFile
object.T
setFileName(java.lang.String name)
Sets the file name of the associatedFileHandler
.T
setFileSystem(FileSystem fs)
Sets theFileSystem
of the associatedFileHandler
.T
setLocationStrategy(FileLocationStrategy strategy)
Sets theFileLocationStrategy
for resolving the referenced file.T
setPath(java.lang.String path)
Sets the location of the associatedFileHandler
as an absolute file path.T
setReloadingDetectorFactory(ReloadingDetectorFactory factory)
Sets the factory for creatingReloadingDetector
objects.T
setReloadingRefreshDelay(java.lang.Long reloadingRefreshDelay)
Sets the refresh delay for reloading supportT
setURL(java.net.URL url)
Sets the location of the associatedFileHandler
as aURL
object.default T
setURL(java.net.URL url, URLConnectionOptions urlConnectionOptions)
Sets the location of the associatedFileHandler
as aURL
object.
-
-
-
Method Detail
-
setBasePath
T setBasePath(java.lang.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(java.lang.String enc)
Sets the encoding of the associatedFileHandler
.- Parameters:
enc
- the encoding- Returns:
- a reference to this object for method chaining
-
setFile
T setFile(java.io.File file)
Sets the location of the associatedFileHandler
as aFile
object.- Parameters:
file
- theFile
location- Returns:
- a reference to this object for method chaining
-
setFileName
T setFileName(java.lang.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 theFileSystem
of the associatedFileHandler
.- Parameters:
fs
- theFileSystem
- Returns:
- a reference to this object for method chaining
-
setLocationStrategy
T setLocationStrategy(FileLocationStrategy strategy)
Sets theFileLocationStrategy
for resolving the referenced file.- Parameters:
strategy
- theFileLocationStrategy
- Returns:
- a reference to this object for method chaining
-
setPath
T setPath(java.lang.String path)
Sets the location of the associatedFileHandler
as 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 creatingReloadingDetector
objects. With this method a custom factory for reloading detectors can be installed. Per default, a factory creatingFileHandlerReloadingDetector
objects is used.- Parameters:
factory
- theReloadingDetectorFactory
- Returns:
- a reference to this object for method chaining
-
setReloadingRefreshDelay
T setReloadingRefreshDelay(java.lang.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(java.net.URL url)
Sets the location of the associatedFileHandler
as aURL
object.- Parameters:
url
- theURL
location- Returns:
- a reference to this object for method chaining
-
setURL
default T setURL(java.net.URL url, URLConnectionOptions urlConnectionOptions)
Sets the location of the associatedFileHandler
as aURL
object.- Parameters:
url
- theURL
locationurlConnectionOptions
- options- Returns:
- a reference to this object for method chaining
- Since:
- 2.8.0
-
-