griffon.javafx.collections.transformation.TransformationMap Maven / Gradle / Ivy

Go to download
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2008-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package griffon.javafx.collections.transformation;

import griffon.javafx.collections.ObservableMapBase;
import javafx.collections.MapChangeListener;
import javafx.collections.ObservableMap;
import javafx.collections.WeakMapChangeListener;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Map;

import static java.util.Objects.requireNonNull;

/**
 * @author Andres Almiray
 * @since 2.11.0
 */
public abstract class TransformationMap extends ObservableMapBase implements ObservableMap {
    private final ObservableMap source;
    private MapChangeListener sourceListener;

    protected TransformationMap(@Nonnull ObservableMap source) {
        this.source = requireNonNull(source, "Argument 'source' must not be null");
        source.addListener(new WeakMapChangeListener<>(getListener()));
    }

    @Nonnull
    public final ObservableMap getSource() {
        return source;
    }

    public MapChangeListener getListener() {
        if (sourceListener == null) {
            sourceListener = TransformationMap.this::sourceChanged;
        }
        return sourceListener;
    }

    public final boolean isInTransformationChain(@Nullable ObservableMap map) {
        if (source == map) {
            return true;
        }
        Map currentSource = source;
        while (currentSource instanceof TransformationMap) {
            currentSource = ((TransformationMap) currentSource).source;
            if (currentSource == map) {
                return true;
            }
        }
        return false;
    }

    protected abstract void sourceChanged(MapChangeListener.Change c);
}