TypeBuilders.StringProp.Builder

class TypeBuilders.StringProp.Builder

Builder for StringProp

Summary

Public constructors

This function is deprecated.

use Builder
Builder(staticValue: String)

Creates an instance of Builder from the given static value.

Public functions
TypeBuilders.StringProp

Builds an instance from accumulated values.
TypeBuilders.StringProp.Builder
@RequiresSchemaVersion(major = 1, minor = 200)
setDynamicValue(dynamicValue: DynamicBuilders.DynamicString)

Sets the dynamic value.
TypeBuilders.StringProp.Builder
@RequiresSchemaVersion(major = 1, minor = 0)
setValue(value: String)

Sets the static value.

Public constructors

Builder

Added in 1.0.0
Deprecated in 1.0.0
Builder()

Creates an instance of Builder.

Builder

Added in 1.0.0
Builder(staticValue: String)

Creates an instance of Builder from the given static value. setDynamicValue can be used to provide a dynamic value.

Public functions

build

Added in 1.0.0
fun build(): TypeBuilders.StringProp

Builds an instance from accumulated values.

Throws
java.lang.IllegalStateException

if a dynamic value is set using setDynamicValue but neither Builder nor setValue is used to provide a static value.

setDynamicValue

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
fun setDynamicValue(dynamicValue: DynamicBuilders.DynamicString): TypeBuilders.StringProp.Builder

Sets the dynamic value. Note that when setting this value, the static value is still required to be set to support older renderers that only read the static value. If dynamicValue has an invalid result, the provided static value will be used instead.

setValue

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 0)
fun setValue(value: String): TypeBuilders.StringProp.Builder

Sets the static value. If a dynamic value is also set and the renderer supports dynamic values for the corresponding field, this static value will be ignored. If the static value is not specified, null will be used instead.