Package org.instancio.internal.settings

Class InternalKey.InternalKeyBuilder<T>

java.lang.Object

org.instancio.internal.settings.InternalKey.InternalKeyBuilder<T>

All Implemented Interfaces:

SettingKey.SettingKeyBuilder<T>

Enclosing class:

InternalKey<T>

public static final class InternalKey.InternalKeyBuilder<T>
extends Object
implements SettingKey.SettingKeyBuilder<T>

Method Summary

Modifier and Type	Method	Description
SettingKey<T>	create()	Returns the created setting key.
SettingKey.SettingKeyBuilder<T>	ofType(Class<T> type)	Specifies the value's type.
SettingKey.SettingKeyBuilder<T>	withPropertyKey(String propertyKey)	Specifies the property key.

Methods inherited from class java.lang.Object

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

Method Details

ofType

public SettingKey.SettingKeyBuilder<T> ofType(Class<T> type)

Description copied from interface: SettingKey.SettingKeyBuilder

Specifies the value's type.

Specified by:

ofType in interface SettingKey.SettingKeyBuilder<T>

Parameters:

type - of value

Returns:

key builder

withPropertyKey

public SettingKey.SettingKeyBuilder<T> withPropertyKey(String propertyKey)

Description copied from interface: SettingKey.SettingKeyBuilder

Specifies the property key.

When defining custom keys, it is advisable to use a custom prefix to distinguish from and to avoid potential clashes with built-in keys, for example:

   com.acme.string.length=10
 

If withPropertyKey() is not specified, then an auto-generated property key will be assigned.

Specified by:

withPropertyKey in interface SettingKey.SettingKeyBuilder<T>

Parameters:

propertyKey - a unique property key

Returns:

key builder

create

public SettingKey<T> create()

Description copied from interface: SettingKey.SettingKeyBuilder

Returns the created setting key.

Specified by:

create in interface SettingKey.SettingKeyBuilder<T>

Returns:

the setting key