eu.mihosoft.vmf.runtime.core.Change Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vmf-runtime Show documentation
VMF (VRL Modeling Framework) is a lightweight modeling framework for generating Java code from data models.
There is a newer version: 0.2.9.4
/*
 * Copyright 2017-2024 Michael Hoffer . All rights reserved.
 * Copyright 2017-2019 Goethe Center for Scientific Computing, University Frankfurt. All rights reserved.
 *
 * 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.
 *
 * If you use this software for scientific research then please cite the following publication(s):
 *
 * M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
 * a framework for declarative GUI programming on the Java platform.
 * Computing and Visualization in Science, 2013, 16(4),
 * 181–192. http://doi.org/10.1007/s00791-014-0230-y
 */
/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package eu.mihosoft.vmf.runtime.core;


import eu.mihosoft.vcollections.VListChangeEvent;

import java.util.*;
import java.util.function.Predicate;


/**
 * A model change.
 *
 * @author Michael Hoffer ([email protected])
 */
@SuppressWarnings("deprecation")
public interface Change {

    /**
     * Returns the object affected by this change
     * @return the object affected by this change
     */
    VObject object();

    /**
     * Returns the name of the property affected by this change.
     * @return the name of the property affected by this change
     */
    String propertyName();

    /**
     * Performs an undo operation (if possible).
     */
    void undo();

    /**
     * Applies this change to the specified object.
     * @param obj target object affected by this change
     */
    void apply(VObject obj);

    /**
     * Indicates whether this change can be reverted.
     * @return {@code true} if this change can be reverted; {@code false} otherwise
     */
    boolean isUndoable();

    /**
     * Returns the property change (optional) which exists if this change affects a single property.
     * @return the property change (optional)
     */
    default Optional propertyChange() {
        return Optional.empty();
    }

    /**
     * Returns the list change (optional) which exists if this change affects a list (list elements added, removed, etc.).
     * @return the list change (optional)
     */
    default Optional> listChange() {
        return Optional.empty();
    }

    /**
     * Change Type
     */
    enum ChangeType {
        /**
         * Change affects a single property.
         */
        PROPERTY,
        /**
         * Change affects a list.
         */
        LIST
    }

    /**
     * Returns the type of this change.
     * @return the type of this change
     */
    ChangeType getType();

    /**
     * Returns the timestamp (in nano seconds) which denotes the creation of this change.
     * @return the timestamp (in nano seconds) which denotes the creation of this change
     */
    long getTimestamp();

}