Class BufferingBeanBuilder<T extends Bean>

  • Type Parameters:
    T - the bean type
    All Implemented Interfaces:
    BeanBuilder<T>

    public class BufferingBeanBuilder<T extends Bean>
    extends java.lang.Object
    implements BeanBuilder<T>
    Implementation of BeanBuilder that buffers data in a local map.

    This is useful for cases where the builder data might be manipulated before the final build. The buffer can be directly mutated.

    • Constructor Summary

      Constructors 
      Constructor Description
      BufferingBeanBuilder​(MetaBean metaBean)
      Constructs the builder wrapping the target bean.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      T build()
      Builds the bean from the state of the builder.
      java.lang.Object get​(java.lang.String propertyName)
      Gets the buffered value associated with the specified property name.
      <P> P get​(MetaProperty<P> metaProperty)
      Gets the buffered value associated with the specified property name.
      java.util.concurrent.ConcurrentMap<MetaProperty<?>,​java.lang.Object> getBuffer()
      Gets the buffer holding the state of the builder.
      MetaBean getMetaBean()
      Gets the meta-beans.
      static BufferingBeanBuilder<?> of​(MetaBean metaBean)
      Constructs the builder wrapping the target bean.
      BeanBuilder<T> set​(java.lang.String propertyName, java.lang.Object value)
      Sets the value of a single property into the builder.
      BeanBuilder<T> set​(MetaProperty<?> metaProperty, java.lang.Object value)
      Sets the value of a single property into the builder.
      java.lang.String toString()
      Returns a string that summarises the builder.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BufferingBeanBuilder

        public BufferingBeanBuilder​(MetaBean metaBean)
        Constructs the builder wrapping the target bean.
        Parameters:
        metaBean - the target meta-bean, not null
    • Method Detail

      • of

        public static BufferingBeanBuilder<?> of​(MetaBean metaBean)
        Constructs the builder wrapping the target bean.
        Parameters:
        metaBean - the target meta-bean, not null
        Returns:
        a new untyped builder, not null
      • getMetaBean

        public MetaBean getMetaBean()
        Gets the meta-beans.
        Returns:
        the meta-bean, not null
      • getBuffer

        public java.util.concurrent.ConcurrentMap<MetaProperty<?>,​java.lang.Object> getBuffer()
        Gets the buffer holding the state of the builder.

        The buffer may be mutated.

        Returns:
        the mutable buffer, not null
      • get

        public java.lang.Object get​(java.lang.String propertyName)
        Gets the buffered value associated with the specified property name.
        Specified by:
        get in interface BeanBuilder<T extends Bean>
        Parameters:
        propertyName - the property name, not null
        Returns:
        the current value in the builder, null if not found or value is null
      • get

        public <P> P get​(MetaProperty<P> metaProperty)
        Gets the buffered value associated with the specified property name.
        Specified by:
        get in interface BeanBuilder<T extends Bean>
        Type Parameters:
        P - the type of the property.
        Parameters:
        metaProperty - the meta-property, not null
        Returns:
        the current value in the builder, null if not found or value is null
      • set

        public BeanBuilder<T> set​(java.lang.String propertyName,
                                  java.lang.Object value)
        Description copied from interface: BeanBuilder
        Sets the value of a single property into the builder.

        This will normally behave as per a Map, however it may not and as a general rule callers should only set each property once.

        Specified by:
        set in interface BeanBuilder<T extends Bean>
        Parameters:
        propertyName - the property name to set, not null
        value - the property value, may be null
        Returns:
        this, for chaining, not null
      • set

        public BeanBuilder<T> set​(MetaProperty<?> metaProperty,
                                  java.lang.Object value)
        Description copied from interface: BeanBuilder
        Sets the value of a single property into the builder.

        This will normally behave as per a Map, however it may not and as a general rule callers should only set each property once.

        Specified by:
        set in interface BeanBuilder<T extends Bean>
        Parameters:
        metaProperty - the meta-property to set, not null
        value - the property value, may be null
        Returns:
        this, for chaining, not null
      • build

        public T build()
        Description copied from interface: BeanBuilder
        Builds the bean from the state of the builder.

        Once this method has been called, the builder is in an invalid state. The effect of further method calls is undetermined.

        Specified by:
        build in interface BeanBuilder<T extends Bean>
        Returns:
        the created bean, not null
      • toString

        public java.lang.String toString()
        Returns a string that summarises the builder.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a summary string, not null