ChangeSetResults.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.commons.compress.changes;

import java.util.ArrayList;
import java.util.List;

/**
 * Stores the results of a performed {@link ChangeSet} operation.
 */
public class ChangeSetResults {

    private final List<String> addedFromChangeSet = new ArrayList<>();
    private final List<String> addedFromStream = new ArrayList<>();
    private final List<String> deleted = new ArrayList<>();

    /**
     * Adds the name of a file to the result list which has been copied from the {@link ChangeSet} to the target stream
     *
     * @param fileName the name of the file
     */
    void addedFromChangeSet(final String fileName) {
        addedFromChangeSet.add(fileName);
    }

    /**
     * Adds the name of a file to the result list which has been copied from the source stream to the target stream.
     *
     * @param fileName the file name which has been added from the original stream
     */
    void addedFromStream(final String fileName) {
        addedFromStream.add(fileName);
    }

    /**
     * Adds the file name of a recently deleted file to the result list.
     *
     * @param fileName the file which has been deleted
     */
    void deleted(final String fileName) {
        deleted.add(fileName);
    }

    /**
     * Gets a list of file names which has been added from the {@link ChangeSet}
     *
     * @return the list of file names
     */
    public List<String> getAddedFromChangeSet() {
        return addedFromChangeSet;
    }

    /**
     * Gets a list of file names which has been added from the original stream
     *
     * @return the list of file names
     */
    public List<String> getAddedFromStream() {
        return addedFromStream;
    }

    /**
     * Gets a list of file names which has been deleted
     *
     * @return the list of file names
     */
    public List<String> getDeleted() {
        return deleted;
    }

    /**
     * Tests if a file name already has been added to the result list
     *
     * @param fileName the file name to check
     * @return true, if this file name already has been added
     */
    boolean hasBeenAdded(final String fileName) {
        return addedFromChangeSet.contains(fileName) || addedFromStream.contains(fileName);
    }
}