/*
* 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.io.comparator;
import java.io.File;
import java.io.Serializable;
import java.util.Comparator;
Compare two files using the default File.compareTo(File)
method.
This comparator can be used to sort lists or arrays of files
by using the default file comparison.
Example of sorting a list of files using the DEFAULT_COMPARATOR
singleton instance:
List<File> list = ...
((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
Example of doing a reverse sort of an array of files using the DEFAULT_REVERSE
singleton instance:
File[] array = ...
((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array);
Since: 1.4
/**
* Compare two files using the <b>default</b> {@link File#compareTo(File)} method.
* <p>
* This comparator can be used to sort lists or arrays of files
* by using the default file comparison.
* <p>
* Example of sorting a list of files using the
* {@link #DEFAULT_COMPARATOR} singleton instance:
* <pre>
* List<File> list = ...
* ((AbstractFileComparator) DefaultFileComparator.DEFAULT_COMPARATOR).sort(list);
* </pre>
* <p>
* Example of doing a <i>reverse</i> sort of an array of files using the
* {@link #DEFAULT_REVERSE} singleton instance:
* <pre>
* File[] array = ...
* ((AbstractFileComparator) DefaultFileComparator.DEFAULT_REVERSE).sort(array);
* </pre>
* <p>
*
* @since 1.4
*/
public class DefaultFileComparator extends AbstractFileComparator implements Serializable {
private static final long serialVersionUID = 3260141861365313518L;
Singleton default comparator instance /** Singleton default comparator instance */
public static final Comparator<File> DEFAULT_COMPARATOR = new DefaultFileComparator();
Singleton reverse default comparator instance /** Singleton reverse default comparator instance */
public static final Comparator<File> DEFAULT_REVERSE = new ReverseComparator(DEFAULT_COMPARATOR);
Compare the two files using the File.compareTo(File)
method. Params: - file1 – The first file to compare
- file2 – The second file to compare
Returns: the result of calling file1's File.compareTo(File)
with file2 as the parameter.
/**
* Compare the two files using the {@link File#compareTo(File)} method.
*
* @param file1 The first file to compare
* @param file2 The second file to compare
* @return the result of calling file1's
* {@link File#compareTo(File)} with file2 as the parameter.
*/
@Override
public int compare(final File file1, final File file2) {
return file1.compareTo(file2);
}
}