com.googlecode.kevinarpe.papaya.filesystem.compare.FileAbsolutePathLexicographicalComparator Maven / Gradle / Ivy

Go to download
package com.googlecode.kevinarpe.papaya.filesystem.compare;

/*
 * #%L
 * This file is part of Papaya.
 * %%
 * Copyright (C) 2013 - 2014 Kevin Connor ARPE ([email protected])
 * %%
 * Papaya is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GPL Classpath Exception:
 * This project is subject to the "Classpath" exception as provided in
 * the LICENSE file that accompanied this code.
 * 
 * Papaya is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Papaya.  If not, see .
 * #L%
 */

import com.googlecode.kevinarpe.papaya.annotation.FullyTested;
import com.googlecode.kevinarpe.papaya.argument.ObjectArgs;
import com.googlecode.kevinarpe.papaya.compare.AbstractLexicographicalComparator;
import com.googlecode.kevinarpe.papaya.compare.CaseSensitive;

import java.io.File;

/**
 * Compares two {@link File} references using {@link File#getAbsolutePath()}.
 *
 * @author Kevin Connor ARPE ([email protected])
 *
 * @see AbstractLexicographicalComparator
 * @see #isCaseSensitive()
 * @see #getCaseSensitive()
 * @see #setCaseSensitive(CaseSensitive)
 * @see #compare(File, File)
 */
@FullyTested
public final class FileAbsolutePathLexicographicalComparator
extends AbstractLexicographicalComparator {

    /**
     * @see AbstractLexicographicalComparator#AbstractLexicographicalComparator()
     */
    public FileAbsolutePathLexicographicalComparator() {
        super();
    }

    /**
     * @see AbstractLexicographicalComparator#AbstractLexicographicalComparator(CaseSensitive)
     */
    public FileAbsolutePathLexicographicalComparator(CaseSensitive caseSensitive) {
        super(caseSensitive);
    }

    /**
     * Compares the results of {@link File#getAbsolutePath()} via
     * {@link #compareStrings(String, String)}.
     * 
     * {@inheritDoc}
     *
     * @param path1
     *        must not be {@code null}
     * @param path2
     *        must not be {@code null}
     *
     * @return
     * 
     *     -1 if {@code path1} is less than {@code path2}
     *     0 if {@code path1} is equal to {@code path2}
     *     +1 if {@code path1} is greater than {@code path2}
     * 
     *
     * @throws NullPointerException
     *         if {@code path1} or {@code path2} is {@code null}
     */
    @Override
    public int compare(File path1, File path2) {
        ObjectArgs.checkNotNull(path1, "path1");
        ObjectArgs.checkNotNull(path2, "path2");

        final String absolutePath1 = path1.getAbsolutePath();
        final String absolutePath2 = path2.getAbsolutePath();
        final int result = compareStrings(absolutePath1, absolutePath2);
        return result;
    }
}