com.alee.extended.tree.AbstractAsyncTreeDataProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaF UI components
There is a newer version: 1.2.14
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.extended.tree;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.utils.compare.Filter;

import java.util.Comparator;
import java.util.List;

/**
 * Abstract {@link AsyncTreeDataProvider} that can contain single comparator and filter for child nodes.
 *
 * @param  node type
 * @author Mikle Garin
 */
public abstract class AbstractAsyncTreeDataProvider implements AsyncTreeDataProvider
{
    /**
     * {@link Filter} for all child nodes.
     * It is {@code transient} as it can only be set through code.
     * Override {@link #getChildrenFilter(AsyncUniqueNode, List)} method to provide parent-related {@link Filter}.
     */
    @Nullable
    protected transient Filter filter = null;

    /**
     * {@link Comparator} for all child nodes.
     * It is {@code transient} as it can only be set through code.
     * Override {@link #getChildrenComparator(AsyncUniqueNode, List)} method to provide parent-related {@link Comparator}.
     */
    @Nullable
    protected transient Comparator comparator = null;

    /**
     * Returns {@code false} by default to allow children load requests to pass through for any node.
     * It is recommended to override this behavior if you can easily determine whether node is leaf or not.
     *
     * @param node {@link AsyncUniqueNode} to check
     * @return {@code false}
     */
    @Override
    public boolean isLeaf ( @NotNull final N node )
    {
        return false;
    }

    @Nullable
    @Override
    public Filter getChildrenFilter ( @NotNull final N parent, @NotNull final List children )
    {
        return filter;
    }

    /**
     * Sets {@link Filter} for all child nodes.
     *
     * @param filter {@link Filter} for all child nodes
     */
    public void setChildrenFilter ( @Nullable final Filter filter )
    {
        this.filter = filter;
    }

    @Nullable
    @Override
    public Comparator getChildrenComparator ( @NotNull final N parent, @NotNull final List children )
    {
        return comparator;
    }

    /**
     * Sets {@link Comparator} for all child nodes.
     *
     * @param comparator {@link Comparator} for all child nodes
     */
    public void setChildrenComparator ( @Nullable final Comparator comparator )
    {
        this.comparator = comparator;
    }
}