Interface IValueBuilder<T>

Type Parameters:
T - Type of the value created by this builder.
All Superinterfaces:
org.apache.commons.lang3.builder.Builder<T>, IValueConfigurator
All Known Subinterfaces:
IAnyValueBuilder, IBooleanValueBuilder, IConstValueBuilder<V>, IFloatValueBuilder, IIntegerValueBuilder, ILargeStringValueBuilder, IListValueBuilder<V>, IMapValueBuilder<V>, INullValueBuilder, IRecordValueBuilder, IStringValueBuilder, ISubTypeValueBuilder<T,Builder>, ITupleValueBuilder, IUnionValueBuilder, IVoidValueBuilder
public interface IValueBuilder<T> extends IValueConfigurator, org.apache.commons.lang3.builder.Builder<T>
Base interface for builders that can create a value of a certain type. A value builder is usually derived from a IValueDescriptor and ensures that the values that is built conforms to the restrictions imposed by the value descriptor.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • asBoolean

      default IBooleanValueBuilder asBoolean()
      Description copied from interface: IValueConfigurator
      Casts this builder to a boolean value builder.
      Specified by:
      asBoolean in interface IValueConfigurator
      Returns:
      getThis() builder cast to a boolean value builder.

    • asConst

      default IConstValueBuilder<?> asConst()
      Description copied from interface: IValueConfigurator
      Casts this builder to a constant value builder.
      Specified by:
      asConst in interface IValueConfigurator
      Returns:
      getThis() builder cast to a constant value builder.

    • asFloat

      default IFloatValueBuilder asFloat()
      Description copied from interface: IValueConfigurator
      Casts this builder to a floating point value builder.
      Specified by:
      asFloat in interface IValueConfigurator
      Returns:
      getThis() builder cast to a floating point value builder.

    • asInteger

      default IIntegerValueBuilder asInteger()
      Description copied from interface: IValueConfigurator
      Casts this builder to an integer value builder.
      Specified by:
      asInteger in interface IValueConfigurator
      Returns:
      getThis() builder cast to an integer value builder.

    • asList

      default <S> IListValueBuilder<S> asList()
      Description copied from interface: IValueConfigurator
      Casts this builder to a list value builder.
      Specified by:
      asList in interface IValueConfigurator
      Returns:
      getThis() builder cast to a list value builder.

    • asMap

      default <V> IMapValueBuilder<V> asMap()
      Description copied from interface: IValueConfigurator
      Casts this builder to a map value builder.
      Specified by:
      asMap in interface IValueConfigurator
      Returns:
      getThis() builder cast to a map value builder.

    • asNull

      default INullValueBuilder asNull()
      Description copied from interface: IValueConfigurator
      Casts this builder to a null value builder.
      Specified by:
      asNull in interface IValueConfigurator
      Returns:
      getThis() builder cast to a null value builder.

    • asRecord

      default IRecordValueBuilder asRecord()
      Description copied from interface: IValueConfigurator
      Casts this builder to a record value builder.
      Specified by:
      asRecord in interface IValueConfigurator
      Returns:
      getThis() builder cast to a record value builder.

    • asString

      default IStringValueBuilder asString()
      Description copied from interface: IValueConfigurator
      Casts this builder to a string value builder.
      Specified by:
      asString in interface IValueConfigurator
      Returns:
      getThis() builder cast to a string value builder.

    • asTuple

      default ITupleValueBuilder asTuple()
      Description copied from interface: IValueConfigurator
      Casts this builder to a tuple value builder.
      Specified by:
      asTuple in interface IValueConfigurator
      Returns:
      getThis() builder cast to a tuple value builder.

    • asUnion

      default IUnionValueBuilder asUnion()
      Description copied from interface: IValueConfigurator
      Casts this builder to a union value builder.
      Specified by:
      asUnion in interface IValueConfigurator
      Returns:
      getThis() builder cast to a union value builder.

    • asVoid

      default IVoidValueBuilder asVoid()
      Description copied from interface: IValueConfigurator
      Casts this builder to a void value builder.
      Specified by:
      asVoid in interface IValueConfigurator
      Returns:
      getThis() builder cast to a void value builder.

    • is

      default boolean is(Class<? extends IValueBuilder> clazz)
      Specified by:
      is in interface IValueConfigurator
      Parameters:
      clazz - Class to check.
      Returns:
      Whether this builder can be cast to the given class.
      See Also:

    • unwrap

      default <TItem, TBuilder extends IValueBuilder<TItem>> TBuilder unwrap(Class<? extends TBuilder> clazz)
      Description copied from interface: IValueConfigurator
      Casts this builder to the given type. Make sure you are certain it is of the given type.
      Specified by:
      unwrap in interface IValueConfigurator
      Type Parameters:
      TItem - Type of the values described by the descriptor.
      TBuilder - Type of the builder.
      Parameters:
      clazz - Class to which to cast this builder.
      Returns:
      getThis() value builder cast to the given type.
      See Also:

    • value

      IValueBuilder<T> 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 IValueConfigurator
      Parameters:
      value - Sets the value created by this builder.
      Returns:
      getThis() builder instance for chaining method calls.

    • whenBoolean

      default IValueBuilder<T> whenBoolean(Consumer<? super IBooleanValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a boolean value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenBoolean in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenConst

      default IValueBuilder<T> whenConst(Consumer<? super IConstValueBuilder<?>> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a const value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenConst in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenFloat

      default IValueBuilder<T> whenFloat(Consumer<? super IFloatValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a float value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenFloat in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenInteger

      default IValueBuilder<T> whenInteger(Consumer<? super IIntegerValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as an integer value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenInteger in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenList

      default IValueBuilder<T> whenList(Consumer<? super IListValueBuilder<?>> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a list value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenList in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenMap

      default IValueBuilder<T> whenMap(Consumer<? super IMapValueBuilder<?>> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a map value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenMap in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenNull

      default IValueBuilder<T> whenNull(Consumer<? super INullValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a null value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenNull in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenRecord

      default IValueBuilder<T> whenRecord(Consumer<? super IRecordValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a record value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenRecord in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenString

      default IValueBuilder<T> whenString(Consumer<? super IStringValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a string value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenString in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenTuple

      default IValueBuilder<T> whenTuple(Consumer<? super ITupleValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a tuple value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenTuple in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenUnion

      default IValueBuilder<T> whenUnion(Consumer<? super IUnionValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a union value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenUnion in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenUnion

      @Deprecated default IValueConfigurator whenUnion(Class<?> discriminatorClass, Consumer<? super IUnionValueBuilder> action)
      Deprecated.
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a union value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenUnion in interface IValueConfigurator
      Parameters:
      discriminatorClass - Unused
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.

    • whenVoid

      default IValueBuilder<T> whenVoid(Consumer<? super IVoidValueBuilder> action)
      Description copied from interface: IValueConfigurator
      Execute the given action with this builder as a void value builder, if this builder is of that type. Does nothing otherwise.
      Specified by:
      whenVoid in interface IValueConfigurator
      Parameters:
      action - Action to execute if this builder is of the desired type.
      Returns:
      This builder instance to chain method calls.