Interface IUnionValueBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<Object>, ISubTypeValueBuilder<Object, IUnionValueBuilder>, IValueBuilder<Object>, IValueConfigurator

public interface IUnionValueBuilder
extends ISubTypeValueBuilder<Object, IUnionValueBuilder>

A IValueBuilder for creating a union value.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default IUnionValueBuilder	asThis()
IDiscriminatedUnionMember<?,?>	buildDiscriminatedMember()	Deprecated. Just use Builder.build().
default Class<?>	getDiscriminatorClass()	Deprecated. Will be removed in a future version.
default IUnionValueBuilder	value(IDiscriminatedUnionMember<?,?> value)	Deprecated. Use ISubTypeValueBuilder.value(Object) with IDiscriminatedUnionMember.getValue().
IUnionValueBuilder	value(Object discriminator, IValueCreator creator)	Deprecated. Use ISubTypeValueBuilder.value(Object).
default IUnionValueBuilder	value(Object discriminator, Class<?> ignoredMemberClass, IValueCreator creator)	Deprecated. Use ISubTypeValueBuilder.value(Object).
default IUnionValueBuilder	value(Object discriminator, Object value)	Deprecated. Use ISubTypeValueBuilder.value(Object).

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

build

Methods inherited from interface ISubTypeValueBuilder

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

Methods inherited from interface IValueBuilder

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

Method Details

asThis

default IUnionValueBuilder asThis()

Specified by:

asThis in interface ISubTypeValueBuilder<Object, IUnionValueBuilder>

Returns:

This instance.

buildDiscriminatedMember

@Deprecated
IDiscriminatedUnionMember<?,?> buildDiscriminatedMember()

Deprecated.

Just use Builder.build(). The discriminator returned by this method is always null.

Builds the discriminated union member representing the current value of this union builder. Always returns a union member with a null discriminator, unless a deprecated legacy method was used to create the union value builder with a specific discriminator.

Returns:

The discriminated union member representing the current value of this union builder.

getDiscriminatorClass

@Deprecated
default Class<?> getDiscriminatorClass()

Deprecated.

Will be removed in a future version. This always returns Object.class.

Gets the class of the union discriminator.

Returns:

Always Object.class

Since:

8.1.0

value

@Deprecated
default IUnionValueBuilder value(Object discriminator,
 Class<?> ignoredMemberClass,
 IValueCreator creator)

Deprecated.

Use ISubTypeValueBuilder.value(Object).

Does nothing unless a deprecated legacy methods was used to create a union value builder with a specific discriminator.

Parameters:

discriminator - Unused.

ignoredMemberClass - Unused.

creator - Value creator the value of the union member value.

Returns:

This value builder for chaining method calls.

value

@Deprecated
IUnionValueBuilder value(Object discriminator,
 IValueCreator creator)

Deprecated.

Use ISubTypeValueBuilder.value(Object).

Does nothing unless a deprecated legacy methods was used to create a union value builder with a specific discriminator.

Parameters:

discriminator - The discriminator of the union member to set.

creator - Value creator the value of the union member value.

Returns:

This value builder for chaining method calls.

value

@Deprecated
default IUnionValueBuilder value(Object discriminator,
 Object value)

Deprecated.

Use ISubTypeValueBuilder.value(Object).

Sets the value of the union at the given member discriminator to the given value.

Parameters:

discriminator - Unused.

value - The value of the union member value.

Returns:

This value builder for chaining method calls.

value

@Deprecated
default IUnionValueBuilder value(IDiscriminatedUnionMember<?,?> value)

Deprecated.

Use ISubTypeValueBuilder.value(Object) with IDiscriminatedUnionMember.getValue(). IDiscriminatedUnionMember.getDiscriminator() is ignored.

Sets the value of the union to the given member.

Parameters:

value - The union member value to set.

Returns:

This value builder for chaining method calls.