Class InterpolatorSpecification.Builder
java.lang.Object
org.apache.commons.configuration2.interpol.InterpolatorSpecification.Builder
- Enclosing class:
- InterpolatorSpecification
A builder class for creating instances of InterpolatorSpecification
.
This class provides a fluent API for defining the various properties of an InterpolatorSpecification
object.
Note: This builder class is not thread-safe.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Collection<Lookup>
A collection with default lookups.private ConfigurationInterpolator
TheConfigurationInterpolator
.private ConfigurationInterpolator
The parentConfigurationInterpolator
.A map with prefix lookups.Function used to convert interpolated values to strings. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
checkLookup
(Lookup lookup) Helper method for checking a lookup.create()
Creates a newInterpolatorSpecification
instance with the properties set so far.void
reset()
Removes all data from this builder.withDefaultLookup
(Lookup lookup) Adds the givenLookup
object to the list of default lookups.withDefaultLookups
(Collection<? extends Lookup> lookups) Adds the content of the given collection to the default lookups managed by this builder.Sets theConfigurationInterpolator
instance for theInterpolatorSpecification
.Sets an optional parentConfigurationInterpolator
.withPrefixLookup
(String prefix, Lookup lookup) Adds aLookup
object for a given prefix.withPrefixLookups
(Map<String, ? extends Lookup> lookups) Adds the content of the given map to the prefix lookups managed by this builder.Sets the function used to convert interpolated values to strings.
-
Field Details
-
prefixLookups
A map with prefix lookups. -
defLookups
A collection with default lookups. -
interpolator
TheConfigurationInterpolator
. -
parentInterpolator
The parentConfigurationInterpolator
. -
stringConverter
Function used to convert interpolated values to strings.
-
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
withPrefixLookup
Adds aLookup
object for a given prefix.- Parameters:
prefix
- the prefix (must not be null)lookup
- theLookup
(must not be null)- Returns:
- a reference to this builder for method chaining
- Throws:
IllegalArgumentException
- if a required parameter is missing
-
withPrefixLookups
Adds the content of the given map to the prefix lookups managed by this builder. The map can be null, then this method has no effect.- Parameters:
lookups
- the map with prefix lookups to be added- Returns:
- a reference to this builder for method chaining
- Throws:
IllegalArgumentException
- if the map contains null values
-
withDefaultLookup
Adds the givenLookup
object to the list of default lookups.- Parameters:
lookup
- theLookup
(must not be null)- Returns:
- a reference to this builder for method chaining
- Throws:
IllegalArgumentException
- if theLookup
is null
-
withDefaultLookups
Adds the content of the given collection to the default lookups managed by this builder. The collection can be null, then this method has no effect.- Parameters:
lookups
- the collection with lookups to be added- Returns:
- a reference to this builder for method chaining
- Throws:
IllegalArgumentException
- if the collection contains null entries
-
withInterpolator
Sets theConfigurationInterpolator
instance for theInterpolatorSpecification
. This means that aConfigurationInterpolator
has been created and set up externally and can be used directly.- Parameters:
ci
- theConfigurationInterpolator
(can be null)- Returns:
- a reference to this builder for method chaining
-
withParentInterpolator
Sets an optional parentConfigurationInterpolator
. If defined, this object is set as parent of a newly createdConfigurationInterpolator
instance.- Parameters:
parent
- the parentConfigurationInterpolator
(can be null)- Returns:
- a reference to this builder for method chaining
-
withStringConverter
Sets the function used to convert interpolated values to strings. Passnull
if the default conversion function is to be used.- Parameters:
fn
- function used to convert interpolated values to string ornull
if the default conversion function is to be used- Returns:
- a reference to this builder for method chaining
-
create
Creates a newInterpolatorSpecification
instance with the properties set so far. After that this builder instance is reset so that it can be reused for creating further specification objects.- Returns:
- the newly created
InterpolatorSpecification
-
reset
public void reset()Removes all data from this builder. Afterwards it can be used to define a brand newInterpolatorSpecification
object. -
checkLookup
Helper method for checking a lookup. Throws an exception if the lookup is null.- Parameters:
lookup
- the lookup to be checked- Throws:
IllegalArgumentException
- if the lookup is null
-