Package de.xima.fc.interfaces.workflow.value

Interface IRecordValueBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<Map<String,?>>, ISubTypeValueBuilder<Map<String,?>,IRecordValueBuilder>, IValueBuilder<Map<String,?>>, IValueConfigurator

public interface IRecordValueBuilder
extends ISubTypeValueBuilder<Map<String,?>,IRecordValueBuilder>

A IValueBuilder for a Map that adheres to a given IRecordValueDescriptor. When no value is given for a property of the record, the default value is used instead. When a property name is given that does not exist on the record, it is ignored.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default IRecordValueBuilder	asThis()
IRecordValueBuilder	property(String key, IValueCreator creator)	Supplies a value for the given property name.
default IRecordValueBuilder	property(String key, Class<?> memberClass, IValueCreator creator)	Deprecated. Use property(String, IValueCreator).
default IRecordValueBuilder	property(String key, Object value)	Supplies a value for the given property name.
default IRecordValueBuilder	value(Object value)	Applies the given value to this builder.

Methods inherited from interface org.apache.commons.lang3.builder.Builder

build

Methods inherited from interface de.xima.fc.interfaces.workflow.value.ISubTypeValueBuilder

whenBoolean, whenConst, whenFloat, whenInteger, whenList, whenMap, whenNull, whenRecord, whenString, whenTuple, whenUnion, whenVoid

Methods inherited from interface de.xima.fc.interfaces.workflow.value.IValueBuilder

asBoolean, asConst, asFloat, asInteger, asList, asMap, asNull, asRecord, asString, asTuple, asUnion, asVoid, is, unwrap, whenUnion

Method Detail

asThis

default IRecordValueBuilder asThis()

Specified by:

asThis in interface ISubTypeValueBuilder<Map<String,?>,IRecordValueBuilder>

Returns:

This instance.

property

@Deprecated
default IRecordValueBuilder property(String key,
                                     Class<?> memberClass,
                                     IValueCreator creator)

Deprecated.

Use property(String, IValueCreator).

Supplies a value for the given property name. When the record does not have that property, the value is ignored.

Parameters:

key - Name of the property.

memberClass - Type of the property value.

creator - A value creator that is given a IValueBuilder and must return the value for the property.

Returns:

This builder for chaining method calls.

property

IRecordValueBuilder property(String key,
                             IValueCreator creator)

Supplies a value for the given property name. When the record does not have that property, the value is ignored.

Parameters:

key - Name of the property.

creator - A value creator that is given a IValueBuilder and must return the value for the property.

Returns:

This builder for chaining method calls.

property

default IRecordValueBuilder property(String key,
                                     Object value)

Supplies a value for the given property name. When the record does not have that property, the value is ignored.

Parameters:

key - Name of the property.

value - The value for the property. Must be an instance of T.

Returns:

This builder for chaining method calls.

value

default IRecordValueBuilder value(Object value)

Description copied from interface: IValueConfigurator

Applies the given value to this builder. Implementations are allowed to perform validity checks on the passed value and reject the given value or parts of it (in case of lists etc.) when they do not conform to the restrictions imposed by this builder.

Specified by:

value in interface ISubTypeValueBuilder<Map<String,?>,IRecordValueBuilder>

Specified by:

value in interface IValueBuilder<Map<String,?>>

Specified by:

value in interface IValueConfigurator

Parameters:

value - Sets the value created by this builder.

Returns:

getThis() builder instance for chaining method calls.