All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.osmerion.quitte.expression.LazyFloatExpression Maven / Gradle / Ivy

Go to download

Specialized, observable properties and observable collections for the JVM.

There is a newer version: 0.8.0
Show newest version
/*
 * Copyright (c) 2018-2022 Leon Linhart,
 * All rights reserved.
 * MACHINE GENERATED FILE, DO NOT EDIT
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.osmerion.quitte.expression;

import java.util.Objects;
import java.util.function.Function;

import javax.annotation.Nullable;

import com.osmerion.quitte.*;
import com.osmerion.quitte.functional.*;
import com.osmerion.quitte.internal.binding.*;
import com.osmerion.quitte.property.*;
import com.osmerion.quitte.value.*;
import com.osmerion.quitte.value.change.*;

/**
 * A specialized lazy {@code float} expression.
 *
 * @since   0.1.0
 *
 * @author  Leon Linhart
 */
public abstract class LazyFloatExpression extends AbstractFloatExpression implements LazyValue {

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableBoolValue observable, BoolToFloatFunction transform) {
        return new Transform(ex -> new BoolToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableByteValue observable, ByteToFloatFunction transform) {
        return new Transform(ex -> new ByteToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableShortValue observable, ShortToFloatFunction transform) {
        return new Transform(ex -> new ShortToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableIntValue observable, IntToFloatFunction transform) {
        return new Transform(ex -> new IntToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableLongValue observable, LongToFloatFunction transform) {
        return new Transform(ex -> new LongToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableFloatValue observable, FloatToFloatFunction transform) {
        return new Transform(ex -> new FloatToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static LazyFloatExpression of(ObservableDoubleValue observable, DoubleToFloatFunction transform) {
        return new Transform(ex -> new DoubleToFloatBinding(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which applies a given transformation to a given observable.
     *
     * @param            the type of the source value
     * @param observable    the observable
     * @param transform     the transformation to apply
     *
     * @return  a new lazy expression which applies a given transformation to a given observable
     *
     * @since   0.1.0
     */
    public static  LazyFloatExpression of(ObservableObjectValue observable, ObjectToFloatFunction transform) {
        return new Transform(ex -> new ObjectToFloatBinding<>(ex::doInvalidate, observable, transform));
    }

    /**
     * Returns a new lazy expression which aliases a child property of an observable.
     *
     * 

The parent observable must never evaluate to {@code null}.

* * @param observable the parent observable * @param selector the function that selects the child property * @param the parent type * * @return a new lazy expression which aliases a child property of an observable * * @since 0.1.0 */ public static LazyFloatExpression ofNested(ObservableObjectValue observable, Function selector) { return new LazyFloatExpression() { final InvalidationListener nestedPropertyListener = ignored -> this.doInvalidate(); { observable.addInvalidationListener(ignored -> this.doInvalidate()); ObjectChangeListener parentChangeListener = (ignored, oldValue, newValue) -> { if (oldValue != null) { var nestedProperty = selector.apply(oldValue); nestedProperty.removeInvalidationListener(this.nestedPropertyListener); } var nestedProperty = selector.apply(Objects.requireNonNull(newValue)); nestedProperty.addInvalidationListener(this.nestedPropertyListener); }; observable.addChangeListener(parentChangeListener); parentChangeListener.onChanged(observable, null, observable.get()); } @Override protected float recomputeValue() { var parent = observable.get(); return selector.apply(Objects.requireNonNull(parent)).get(); } }; } private final SimpleObjectProperty state = new SimpleObjectProperty<>(State.UNINITIALIZED) { @Override public void onChanged(@Nullable State prevValue, @Nullable State value) { //noinspection ConstantConditions if (!value.isValid()) LazyFloatExpression.this.notifyInvalidationListeners(); } }; @Nullable private FloatSupplier provider = this::recomputeValue; private float value; /** * Returns a read-only view of this expression's state. * * @return a read-only view of this expression's state * * @implNote The view is not cached since calling this method is expected to be a rare operation. * * @since 0.1.0 */ public final ReadableObjectProperty stateProperty() { return this.state.asReadOnlyProperty(); } /** * Returns the current state of this expression. * * @return the current state of this expression * * @since 0.1.0 */ public final State getState() { //noinspection ConstantConditions return this.state.get(); } /** * {@inheritDoc} * * @since 0.1.0 */ @Override public final float get() { //noinspection ConstantConditions if (!this.state.get().isValid()) { var provider = Objects.requireNonNull(this.provider); this.updateValue(provider.get(), !this.state.get().isValid()); this.provider = null; } return this.value; } @Override final float getImpl() { return this.value; } @Override final void setImpl(float value) { this.value = value; } @Override final void doInvalidate() { this.provider = this::recomputeValue; //noinspection ConstantConditions if (this.state.get().isValid()) this.state.set(State.INVALID); } @Override final boolean onChangedInternal(float oldValue, float newValue) { if (this.state.get() != State.UNINITIALIZED) { this.state.set(State.VALID); return true; } else { this.state.set(State.INITIALIZED); return false; } } /** A simple expression transforming a single value using the internal binding API. */ private static final class Transform extends LazyFloatExpression { private final transient FloatBinding binding; private Transform(Function factory) { this.binding = factory.apply(this); } @Override protected float recomputeValue() { return this.binding.get(); } } }