Method Details

• create

  @NonNull public static PropertiesBuilder create()

  Factory method used to create a default PropertiesBuilder instance.

  Returns:

  an instance of the PropertiesBuilder class with not Properties.

  See Also:

  • PropertiesBuilder()

• from

  @NonNull public static PropertiesBuilder from(@NonNull Properties properties)

  Factory method used 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

  @NonNull public static PropertiesBuilder from(@NonNull InputStream in)

  Constructs a new instance of PropertiesBuilder initialized with 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:

  • Properties.load(InputStream)
  • InputStream

• from

  @NonNull public static PropertiesBuilder from(@NonNull Reader reader)

  Constructs a new isntance of PropertiesBuilder initialized with 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:

  • Properties.load(Reader)
  • Reader

• fromXml

  @NonNull public static PropertiesBuilder fromXml(@NonNull InputStream xml)

  Constructs a new instance of PropertiesBuilder initialized with 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:

  • Properties.loadFromXML(InputStream)
  • InputStream

• getObject

  @NonNull public Properties getObject() throws Exception

  Specified by:

  getObject in interface org.springframework.beans.factory.FactoryBean<Properties>

  Throws:

  Exception

• getObjectType

  @NonNull public Class<?> getObjectType()

  Specified by:

  getObjectType in interface org.springframework.beans.factory.FactoryBean<Properties>

• isSingleton

  public boolean isSingleton()

  Specified by:

  isSingleton in interface org.springframework.beans.factory.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