io.permazen.change.ListFieldRemove Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of permazen-main Show documentation
Permazen classes that map Java model classes onto the core API.
The newest version!

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.change;

import com.google.common.base.Preconditions;

import io.permazen.PermazenObject;
import io.permazen.PermazenTransaction;
import io.permazen.annotation.OnChange;

import java.util.Objects;

/**
 * Notification object that gets passed to {@link OnChange @OnChange}-annotated methods
 * when an element is removed from a list field.
 *
 * @param  the type of the object containing the changed field
 * @param  the type of the changed list's elements
 */
public class ListFieldRemove extends ListFieldChange {

    private final int index;
    private final E element;

    /**
     * Constructor.
     *
     * @param jobj Java object containing the list field that changed
     * @param fieldName the name of the field that changed
     * @param index index at which the removal occurred
     * @param element the element that was removed
     * @throws IllegalArgumentException if {@code jobj} or {@code fieldName} is null
     */
    public ListFieldRemove(T jobj, String fieldName, int index, E element) {
        super(jobj, fieldName);
        this.index = index;
        this.element = element;
    }

    @Override
    public  R visit(ChangeSwitch target) {
        return target.caseListFieldRemove(this);
    }

    @Override
    public void apply(PermazenTransaction jtx, PermazenObject jobj) {
        Preconditions.checkArgument(jtx != null, "null jtx");
        Preconditions.checkArgument(jobj != null, "null jobj");
        jtx.readListField(jobj.getObjId(), this.getFieldName(), false).remove(this.index);
    }

    /**
     * Get the list index from which the element was removed.
     *
     * @return the index at which the value was removed
     */
    public int getIndex() {
        return this.index;
    }

    /**
     * Get the element that was removed from the list.
     *
     * @return the value removed from the list
     */
    public E getElement() {
        return this.element;
    }

// Object

    @Override
    public boolean equals(Object obj) {
        if (obj == this)
            return true;
        if (!super.equals(obj))
            return false;
        final ListFieldRemove that = (ListFieldRemove)obj;
        return this.index == that.index && Objects.equals(this.element, that.element);
    }

    @Override
    public int hashCode() {
        return super.hashCode() ^ this.index ^ Objects.hashCode(this.element);
    }

    @Override
    public String toString() {
        return "ListFieldRemove[object=" + this.getObject() + ",field=\"" + this.getFieldName() + "\",index="
          + this.index + ",element=" + this.element + "]";
    }
}