FluentHasValue.java

package org.vaadin.viritin.fluency.ui;

import com.vaadin.data.HasValue;

public interface FluentHasValue<S, V> extends HasValue<V> {
    /**
     * Sets the value of this object. If the new value is not equal to
     * {@code getValue()}, fires a value change event. May throw
     * {@code IllegalArgumentException} if the value is not acceptable.
     * <p>
     * <i>Implementation note:</i> the implementing class should document
     * whether null values are accepted or not.
     *
     * @param value
     *            the new value
     * @return this (for method chaining)
     * @throws IllegalArgumentException
     *             if the value is invalid
     */
    public default S withValue(V value) {
        ((HasValue<V>) this).setValue(value);
        return (S) this;
    }

    /**
     * Sets the read-only mode of this {@code HasValue} to given mode. The user
     * can't change the value when in read-only mode.
     * <p>
     * A {@code HasValue} with a visual component in read-only mode typically
     * looks visually different to signal to the user that the value cannot be
     * edited.
     *
     * @param readOnly
     *            a boolean value specifying whether the component is put
     *            read-only mode or not
     * @return this (for method chaining)
     */
    public default S withReadOnly(boolean readOnly) {
        ((HasValue<V>) this).setReadOnly(readOnly);
        return (S) this;
    }

    /**
     * Sets the required indicator visible or not.
     * <p>
     * If set visible, it is visually indicated in the user interface.
     *
     * @param requiredIndicatorVisible
     *            <code>true</code> to make the required indicator visible,
     *            <code>false</code> if not
     * @return this (for method chaining)
     */
    public default S withRequiredIndicatorVisible(
            boolean requiredIndicatorVisible) {
        ((HasValue<V>) this)
                .setRequiredIndicatorVisible(requiredIndicatorVisible);
        return (S) this;
    }
}