org.refcodes.collection

Interface Properties.PropertiesBuilder

All Superinterfaces:

Clearable, Containable, Dictionary<String,String>, Dictionary.ClearableDictionary<String,String>, Dictionary.MutableDictionary<String,String>, Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,Properties.PropertiesBuilder>, Keys<String,String>, Keys.ClearableKeys<String,String>, Keys.MutableKeys<String,String>, Properties, Properties.ClearableProperties, Properties.MutableProperties

All Known Implementing Classes:

PropertiesImpl.PropertiesBuilderImpl

Enclosing interface:

Properties

public static interface Properties.PropertiesBuilder
extends Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,Properties.PropertiesBuilder>, Properties.MutableProperties

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.collection.Properties

Properties.ClearableProperties, Properties.MutableProperties, Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.collection.Dictionary.MutableDictionary

Dictionary.MutableDictionary.DictionaryBuilder<K,V,T extends org.refcodes.structure.Relation<K,V>,B extends Dictionary.MutableDictionary.DictionaryBuilder<K,V,T,B>>

Nested classes/interfaces inherited from interface org.refcodes.collection.Dictionary

Dictionary.ClearableDictionary<K,V>, Dictionary.MutableDictionary<K,V>

Nested classes/interfaces inherited from interface org.refcodes.collection.Keys

Keys.ClearableKeys<K,V>, Keys.MutableKeys<K,V>

Method Summary

Modifier and Type	Method and Description
default Properties.PropertiesBuilder	withLoadFrom(File aFile) Builder method for Properties.MutableProperties.loadFrom(File).
default Properties.PropertiesBuilder	withLoadFrom(String aFilePath) Builder method for Properties.MutableProperties.loadFrom(String).
default Properties.PropertiesBuilder	withPut(org.refcodes.structure.Property aProperty)
default Properties.PropertiesBuilder	withPut(String aKey, String aValue)
default Properties.PropertiesBuilder	withPutBoolean(String aKey, Boolean aValue) Sets the Boolean value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutByte(String aKey, Byte aValue) Sets the Byte value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutDouble(String aKey, Double aValue) Sets the Double value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutFloat(String aKey, Float aValue) Sets the Float value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutInteger(String aKey, Integer aValue) Sets the Integer value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutLong(String aKey, Long aValue) Sets the Long value for the property referred to by the key.
default Properties.PropertiesBuilder	withPutShort(String aKey, Short aValue) Sets the Short value for the property referred to by the key.
default Properties.PropertiesBuilder	withSaveTo(File aFile) Builder method for Properties.saveTo(File).
default Properties.PropertiesBuilder	withSaveTo(File aFile, String aComment) Builder method for Properties.saveTo(File, String).
default Properties.PropertiesBuilder	withSaveTo(String aFilePath) Builder method for Properties.saveTo(String).
default Properties.PropertiesBuilder	withSaveTo(String aFilePath, String aComment) Builder method for Properties.saveTo(String, String).

Methods inherited from interface org.refcodes.collection.Properties.MutableProperties

loadFrom, loadFrom, put, putAll, putAll, putAll, putBoolean, putByte, putDouble, putFloat, putInteger, putLong, putShort

Methods inherited from interface org.refcodes.collection.Properties

getBoolean, getByte, getDouble, getFloat, getInteger, getLong, getShort, saveTo, saveTo, saveTo, saveTo, toMap, toProperties

Methods inherited from interface org.refcodes.collection.Dictionary.MutableDictionary

put, put

Methods inherited from interface org.refcodes.collection.Containable

isEmpty, size

Methods inherited from interface org.refcodes.collection.Keys

containsKey, get, keySet, values

Methods inherited from interface org.refcodes.collection.Clearable

clear

Methods inherited from interface org.refcodes.collection.Keys.MutableKeys

removeByKey

Method Detail

withPut

default Properties.PropertiesBuilder withPut(String aKey,
                                             String aValue)

Specified by:

withPut in interface Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,Properties.PropertiesBuilder>

withPut

default Properties.PropertiesBuilder withPut(org.refcodes.structure.Property aProperty)

Specified by:

withPut in interface Dictionary.MutableDictionary.DictionaryBuilder<String,String,org.refcodes.structure.Property,Properties.PropertiesBuilder>

withPutInteger

default Properties.PropertiesBuilder withPutInteger(String aKey,
                                                    Integer aValue)

Sets the Integer value for the property referred to by the key. As property keys and values are of type String, the Integer value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Integer representation for the String value.

Returns:

This instance for further builder method calls.

withPutShort

default Properties.PropertiesBuilder withPutShort(String aKey,
                                                  Short aValue)

Sets the Short value for the property referred to by the key. As property keys and values are of type String, the Short value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Short representation for the String value.

Returns:

This instance for further builder method calls.

withPutByte

default Properties.PropertiesBuilder withPutByte(String aKey,
                                                 Byte aValue)

Sets the Byte value for the property referred to by the key. As property keys and values are of type String, the Byte value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Byte representation for the String value.

Returns:

This instance for further builder method calls.

withPutDouble

default Properties.PropertiesBuilder withPutDouble(String aKey,
                                                   Double aValue)

Sets the Double value for the property referred to by the key. As property keys and values are of type String, the Double value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Double representation for the String value.

Returns:

This instance for further builder method calls.

withPutFloat

default Properties.PropertiesBuilder withPutFloat(String aKey,
                                                  Float aValue)

Sets the Float value for the property referred to by the key. As property keys and values are of type String, the Float value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Float representation for the String value.

Returns:

This instance for further builder method calls.

withPutBoolean

default Properties.PropertiesBuilder withPutBoolean(String aKey,
                                                    Boolean aValue)

Sets the Boolean value for the property referred to by the key. As property keys and values are of type String, the Boolean value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Boolean representation for the String value.

Returns:

This instance for further builder method calls.

withPutLong

default Properties.PropertiesBuilder withPutLong(String aKey,
                                                 Long aValue)

Sets the Long value for the property referred to by the key. As property keys and values are of type String, the Long value is converted accordingly.

Parameters:

aKey - The key for which to retrieve the value.

aValue - The Long representation for the String value.

Returns:

This instance for further builder method calls.

withLoadFrom

default Properties.PropertiesBuilder withLoadFrom(File aFile)
                                           throws IOException

Builder method for Properties.MutableProperties.loadFrom(File).

Parameters:

aFile - The file from which to load the properties.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case loading the properties failed

withLoadFrom

default Properties.PropertiesBuilder withLoadFrom(String aFilePath)
                                           throws IOException

Builder method for Properties.MutableProperties.loadFrom(String).

Parameters:

aFilePath - The file path from which to load the properties.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case loading the properties failed

withSaveTo

default Properties.PropertiesBuilder withSaveTo(File aFile)
                                         throws IOException

Builder method for Properties.saveTo(File).

Parameters:

aFile - The File from which to load the properties.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case saving the properties failed

withSaveTo

default Properties.PropertiesBuilder withSaveTo(String aFilePath)
                                         throws IOException

Builder method for Properties.saveTo(String).

Parameters:

aFilePath - The file path from which to load the properties.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case saving the properties failed

withSaveTo

default Properties.PropertiesBuilder withSaveTo(File aFile,
                                                String aComment)
                                         throws IOException

Builder method for Properties.saveTo(File, String).

Parameters:

aFile - The File from which to load the properties.

aComment - The description for the properties file.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case saving the properties failed

withSaveTo

default Properties.PropertiesBuilder withSaveTo(String aFilePath,
                                                String aComment)
                                         throws IOException

Builder method for Properties.saveTo(String, String).

Parameters:

aFilePath - The file path from which to load the properties.

aComment - The description for the properties file.

Returns:

This instance for further builder method calls.

Throws:

IOException - thrown in case saving the properties failed