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

Interface IValueBuilder<T>

Type Parameters:
T - Type of the value created by this builder.
All Superinterfaces:
org.apache.commons.lang3.builder.Builder<T>
All Known Subinterfaces:
IAnyValueBuilder, IBooleanValueBuilder, IConstValueBuilder<V>, IFloatValueBuilder, IIntegerValueBuilder, ILargeStringValueBuilder, IListValueBuilder<V>, IMapValueBuilder<V>, INullValueBuilder, IRecordValueBuilder, IStringValueBuilder, ITupleValueBuilder, IUnionValueBuilder<D>, IVoidValueBuilder
public interface IValueBuilder<T> extends 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()
      Casts this builder to a boolean value builder.
      Returns:
      This builder cast to a boolean value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asConst

      default <S> IConstValueBuilder<S> asConst()
      Casts this builder to a constant value builder.
      Type Parameters:
      S - Type of the constant value.
      Returns:
      This builder cast to a constant value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asFloat

      default IFloatValueBuilder asFloat()
      Casts this builder to a floating point value builder.
      Returns:
      This builder cast to a floating point value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asInteger

      default IIntegerValueBuilder asInteger()
      Casts this builder to an integer value builder.
      Returns:
      This builder cast to an integer value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asList

      default <S> IListValueBuilder<S> asList()
      Casts this builder to a list value builder.
      Returns:
      This builder cast to a list value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asMap

      default <V> IMapValueBuilder<V> asMap()
      Casts this builder to a map value builder.
      Returns:
      This builder cast to a map value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asNull

      default INullValueBuilder asNull()
      Casts this builder to a null value builder.
      Returns:
      This builder cast to a null value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asRecord

      default IRecordValueBuilder asRecord()
      Casts this builder to a record value builder.
      Returns:
      This builder cast to a record value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asString

      default IStringValueBuilder asString()
      Casts this builder to a string value builder.
      Returns:
      This builder cast to a string value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asTuple

      default ITupleValueBuilder asTuple()
      Casts this builder to a tuple value builder.
      Returns:
      This builder cast to a tuple value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asUnion

      default <D> IUnionValueBuilder<D> asUnion()
      Casts this builder to a union value builder.
      Type Parameters:
      D - Type of then union discriminator.
      Returns:
      This builder cast to a union value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • asVoid

      default IVoidValueBuilder asVoid()
      Casts this builder to a void value builder.
      Returns:
      This builder cast to a void value builder.
      Throws:
      ClassCastException - When this builder cannot be cast to the desired type.

    • is

      default boolean is(Class<? extends IValueBuilder> clazz)
      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)
      Casts this builder to the given type. Make sure you are certain it is of the given type.
      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:
      This value builder cast to the given type.
      Throws:
      ClassCastException - When this descriptor cannot be cast to the given type.
      See Also:

    • value

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