org.springframework.data.gemfire.util

Class PropertiesBuilder

java.lang.Object

org.springframework.data.gemfire.util.PropertiesBuilder

All Implemented Interfaces:

FactoryBean<Properties>

public class PropertiesBuilder
extends Object
implements FactoryBean<Properties>

The PropertiesBuilder class is a Builder for Properties.

Since:

1.9.0

Author:

John Blum

See Also:

Properties, FactoryBean

Field Summary

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
PropertiesBuilder() Constructs an instance of the PropertiesBuilder class.
PropertiesBuilder(Properties defaults) Constructs an instance of the PropertiesBuilder class initialized with the default Properties.
PropertiesBuilder(PropertiesBuilder builder) Constructs an instance of the PropertiesBuilder class initialized with the given PropertiesBuilder providing the default Properties for this builder.

Method Summary

Modifier and Type	Method and Description
PropertiesBuilder	add(Properties properties) Null-safe method to add all the Properties to this builder.
PropertiesBuilder	add(PropertiesBuilder builder) Null-safe method to add all the Properties from the provided PropertiesBuilder to this builder.
Properties	build() Builds the Properties object from this builder.
static PropertiesBuilder	create() Factory method to create a default PropertiesBuilder instance.
static PropertiesBuilder	from(InputStream in) Constructs and initializes a PropertiesBuilder containing all properties from the given InputStream.
static PropertiesBuilder	from(Properties properties) Factory method to create an instance of PropertiesBuilder initialized with the given Properties.
static PropertiesBuilder	from(Reader reader) Constructs and initializes a PropertiesBuilder containing all properties from the given Reader.
static PropertiesBuilder	fromXml(InputStream xml) Constructs and initializes a PropertiesBuilder containing all properties from the given InputStream in XML format.
Properties	getObject()
Class<?>	getObjectType()
boolean	isSingleton()
protected boolean	isValuable(String value) Determine whether the given String value is a valid Properties value.
PropertiesBuilder	setProperty(String name, Object value) Sets a property with given name to the specified value.
PropertiesBuilder	setProperty(String name, Object[] values) Sets the named property to the given array of object values.
PropertiesBuilder	setProperty(String name, String value) Sets a property with the given name to the specified String value.
<T> PropertiesBuilder	setPropertyIfNotDefault(String name, Object value, T defaultValue) Sets the named property to the given value if the defaultValue is not null and value is not equal to defaultValue.
PropertiesBuilder	unsetProperty(String name) Un-sets the named property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesBuilder

public PropertiesBuilder()

Constructs an instance of the PropertiesBuilder class.

PropertiesBuilder

public PropertiesBuilder(Properties defaults)

Constructs an instance of the PropertiesBuilder class initialized with the default Properties.

Parameters:

defaults - Properties used as the defaults.

Throws:

NullPointerException - if the Properties reference is null.

See Also:

Properties

PropertiesBuilder

public PropertiesBuilder(PropertiesBuilder builder)

Constructs an instance of the PropertiesBuilder class initialized with the given PropertiesBuilder providing the default Properties for this builder.

Parameters:

builder - PropertiesBuilder providing the default Properties for this builder.

Throws:

NullPointerException - if the PropertiesBuilder reference is null.

See Also:

PropertiesBuilder(Properties)

Method Detail

create

public static PropertiesBuilder create()

Factory method to create a default PropertiesBuilder instance.

Returns:

an instance of the PropertiesBuilder class with not Properties.

See Also:

PropertiesBuilder()

from

public static PropertiesBuilder from(Properties properties)

Factory method to create an instance of PropertiesBuilder initialized with the given Properties.

Parameters:

properties - Properties used as the default properties of the constructed PropertiesBuilder.

Returns:

an instance of PropertiesBuilder initialized with the given Properties.

See Also:

Properties, PropertiesBuilder(Properties)

from

public static PropertiesBuilder from(InputStream in)

Constructs and initializes a PropertiesBuilder containing all properties from the given InputStream.

Parameters:

in - InputStream source containing properties to use as the defaults for the constructed builder.

Returns:

a PropertiesBuilder initialized with properties from the given InputStream.

Throws:

IllegalArgumentException - if the InputStream cannot be read.

See Also:

InputStream, Properties.load(InputStream)

from

public static PropertiesBuilder from(Reader reader)

Constructs and initializes a PropertiesBuilder containing all properties from the given Reader.

Parameters:

reader - Reader source containing properties to use as the defaults for the constructed builder.

Returns:

a PropertiesBuilder initialized with properties from the given Reader.

Throws:

IllegalArgumentException - if the Reader cannot be read.

See Also:

Reader, Properties.load(Reader)

fromXml

public static PropertiesBuilder fromXml(InputStream xml)

Constructs and initializes a PropertiesBuilder containing all properties from the given InputStream in XML format.

Parameters:

xml - InputStream source containing properties in XML format to use as defaults for the constructed builder.

Returns:

a PropertiesBuilder initialized with properties from the given XML InputStream.

Throws:

IllegalArgumentException - if the XML InputStream cannot be read.

See Also:

InputStream, Properties.loadFromXML(InputStream)

getObject

@NonNull
public Properties getObject()
                              throws Exception

Specified by:

getObject in interface FactoryBean<Properties>

Throws:

Exception

getObjectType

@NonNull
public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<Properties>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface FactoryBean<Properties>

add

@NonNull
public PropertiesBuilder add(@Nullable
                                      Properties properties)

Null-safe method to add all the Properties to this builder. This operation effectively overwrites any properties already set with the same name from the source.

Parameters:

properties - Properties to add to this builder.

Returns:

a reference to this PropertiesBuilder.

See Also:

Properties

add

@NonNull
public PropertiesBuilder add(@Nullable
                                      PropertiesBuilder builder)

Null-safe method to add all the Properties from the provided PropertiesBuilder to this builder. This operation effectively overwrites any properties already set with the same name from the source.

Parameters:

builder - source of the Properties to add to this builder.

Returns:

a reference to this PropertiesBuilder.

See Also:

PropertiesBuilder

setProperty

@NonNull
public PropertiesBuilder setProperty(@NonNull
                                              String name,
                                              @NonNull
                                              Object value)

Sets a property with given name to the specified value. The property is only set if the value is not null.

Parameters:

name - the name of the property to set.

value - the value to set the property to.

Returns:

a reference to this PropertiesBuilder.

See Also:

setProperty(String, String)

setProperty

@NonNull
public PropertiesBuilder setProperty(@NonNull
                                              String name,
                                              @Nullable
                                              Object[] values)

Sets the named property to the given array of object values. The property is only set if the array of object value is not null or empty.

Parameters:

name - name of the property to set.

values - array of object values used as the property's value.

Returns:

a reference to this PropertiesBuilder

See Also:

StringUtils.arrayToCommaDelimitedString(Object[]), setProperty(String, String)

setProperty

@NonNull
public PropertiesBuilder setProperty(@NonNull
                                              String name,
                                              @NonNull
                                              String value)

Sets a property with the given name to the specified String value. The property is only set if the value is not null, an empty String or not equal to the String literal null, ignoring case.

Parameters:

name - the name of the property to set.

value - the value to set the property to.

Returns:

a reference to this PropertiesBuilder.

Throws:

IllegalArgumentException - if the property name is not specified.

See Also:

Properties.setProperty(String, String)

setPropertyIfNotDefault

@NonNull
public <T> PropertiesBuilder setPropertyIfNotDefault(@NonNull
                                                              String name,
                                                              Object value,
                                                              T defaultValue)

Sets the named property to the given value if the defaultValue is not null and value is not equal to defaultValue.

Type Parameters:

T - Class type of the property value.

Parameters:

name - name of the property to set.

value - value to set for the property.

defaultValue - default value of the property to compare with the given value when determining whether to set the property.

Returns:

a reference to this PropertiesBuilder.

See Also:

setProperty(String, Object)

unsetProperty

@NonNull
public PropertiesBuilder unsetProperty(@NonNull
                                                String name)

Un-sets the named property. This method sets the given named property to an empty String.

Parameters:

name - name of the property to unset.

Returns:

a reference to this PropertiesBuilder.

Throws:

IllegalArgumentException - if the property name is not specified.

isValuable

protected boolean isValuable(@Nullable
                             String value)

Determine whether the given String value is a valid Properties value. A property value is considered valid if it is not null, not empty and not equal to (case-insensitive) String literal null.

Parameters:

value - String value for the property being set.

Returns:

a boolean value indicating whether the given String value is a valid Properties value.

build

@NonNull
public Properties build()

Builds the Properties object from this builder.

Returns:

the Properties object built by this builder.

See Also:

Properties