com.canoo.dolphin.collections.ListChangeEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-rpm-common Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

There is a newer version: 0.16.0

Show newest version

/*
 * Copyright 2015-2017 Canoo Engineering AG.
 *
 * 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 com.canoo.dolphin.collections;

import java.util.List;

/**
 * An event that defines the change of an {@link ObservableList}.
 * @param  generic type of the list.
 */
public interface ListChangeEvent {

    /**
     * Returns the list that has triggered this event
     * @return the list
     */
    ObservableList getSource();

    /**
     * Returns a list of changes of this event
     * @return
     */
    List> getChanges();

    /**
     * Defines one change in an {@link ObservableList}.
     * @param  generic type of the list.
     */
    interface Change {

        int getFrom();

        int getTo();

        /**
         * Returns a list that contains all elements that were removed from the list.
         * @return
         */
        List getRemovedElements();

        /**
         * Returns true if elements were added to the list
         * @return true if elements were added to the list
         */
        boolean isAdded();

        /**
         * Returns true if elements were removed from the list
         * @return true if elements were removed from the list
         */
        boolean isRemoved();

        /**
         * Returns true if elements were replaced in the list
         * @return true if elements were replaced in the list
         */
        boolean isReplaced();
    }
}