eu.fraho.libs.swing.widgets.events.DataChangedEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swing-components Show documentation
GUI components to enhance swing
The newest version!
package eu.fraho.libs.swing.widgets.events;

import eu.fraho.libs.swing.widgets.base.AbstractWComponent;
import eu.fraho.libs.swing.widgets.base.WComponent;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.time.LocalDateTime;
import java.util.EventObject;

/**
 * This event is used by all {@link WComponent}s when the data changed. There
 * are several different reasons {@link #why} this event is raised.

 * All events define a {@link #getSource() source}, which component changed and
 * a {@link LocalDateTime}, {@link #when} this event occured.

 * Each event also provides the {@link #oldValue old} and {@link #newValue new}
 * value. These events are normally handled by a {@link DataChangedListener}.
 *
 * @author Simon Frankenberger
 */
@SuppressWarnings("DefaultAnnotationParam")
@Getter
@ToString
@EqualsAndHashCode(exclude = "when", callSuper = false)
public class DataChangedEvent extends EventObject {
    /**
     * when was this event created
     */
    @NotNull
    private final LocalDateTime when;
    /**
     * whats the cause of this event
     */
    @NotNull
    private final ChangeType why;
    /**
     * the old value, before this event was raised
     */
    @Nullable
    private final Object newValue;
    /**
     * the new value, after this event will be raised
     */
    @Nullable
    private final Object oldValue;

    /**
     * Create a new event with the given data.
     *
     * @param source The {@link WComponent} which raises this event.
     * @param oldVal The old value
     * @param newVal The new value
     * @param why    The cause of this event
     */
    public DataChangedEvent(@NotNull @NonNull AbstractWComponent source, @Nullable Object oldVal, @Nullable Object newVal, @NotNull @NonNull ChangeType why) {
        super(source);
        this.oldValue = oldVal;
        this.newValue = newVal;
        this.why = why;
        when = LocalDateTime.now();
    }

    @Override
    @NotNull
    public AbstractWComponent getSource() {
        return (AbstractWComponent) super.getSource();
    }

    /**
     * Why was this event raised?

     * Possible values:
     * 
     * {@link #CHANGED}
     * {@link #COMMIT}
     * {@link #ROLLBACK}
     * 
     */
    public enum ChangeType {
        /**
         * the value changed
         */
        CHANGED,

        /**
         * the value is about to be committed
         */
        COMMIT,

        /**
         * the value is about to be rolled back
         */
        ROLLBACK,
    }
}