com.github.difflib.patch.AbstractDelta Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of diffutils Show documentation

The DiffUtils library for computing diffs, applying patches, generationg side-by-side view in Java.

The newest version!

/*
 * Copyright 2018 java-diff-utils.
 *
 * 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.github.difflib.patch;

import java.util.List;
import java.util.Objects;

/**
 * Abstract delta between a source and a target. 
 * @author Tobias Warneke ([email protected])
 */
public abstract class AbstractDelta {
    private final Chunk source;
    private final Chunk target;
    private final DeltaType type;
    
    public AbstractDelta(DeltaType type, Chunk source, Chunk target) {
        Objects.requireNonNull(source);
        Objects.requireNonNull(target);
        Objects.requireNonNull(type);
        this.type = type;
        this.source = source;
        this.target = target;
    }

    public Chunk getSource() {
        return source;
    }

    public Chunk getTarget() {
        return target;
    }

    public DeltaType getType() {
        return type;
    }
    
    /**
     * Verify the chunk of this delta, to fit the target.
     * @param target
     * @throws PatchFailedException 
     */
    protected void verifyChunk(List target) throws PatchFailedException {
        getSource().verify(target);
    }
    
    public abstract void applyTo(List target) throws PatchFailedException;
    
    public abstract void restore(List target);

    @Override
    public int hashCode() {
        int hash = 3;
        hash = 61 * hash + Objects.hashCode(this.source);
        hash = 61 * hash + Objects.hashCode(this.target);
        hash = 61 * hash + Objects.hashCode(this.type);
        return hash;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final AbstractDelta other = (AbstractDelta) obj;
        if (!Objects.equals(this.source, other.source)) {
            return false;
        }
        if (!Objects.equals(this.target, other.target)) {
            return false;
        }
        if (this.type != other.type) {
            return false;
        }
        return true;
    }
}