14fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/* 24fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Licensed to the Apache Software Foundation (ASF) under one or more 34fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * contributor license agreements. See the NOTICE file distributed with 44fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * this work for additional information regarding copyright ownership. 54fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * The ASF licenses this file to You under the Apache License, Version 2.0 64fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * (the "License"); you may not use this file except in compliance with 74fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * the License. You may obtain a copy of the License at 84fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 94fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * http://www.apache.org/licenses/LICENSE-2.0 104fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 114fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Unless required by applicable law or agreed to in writing, software 124fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * distributed under the License is distributed on an "AS IS" BASIS, 134fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 144fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * See the License for the specific language governing permissions and 154fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * limitations under the License. 164fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 174fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypackage org.apache.commons.io.comparator; 184fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 194fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.File; 204fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.Serializable; 214fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.util.Comparator; 224fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 234fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/** 244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Compare two files using the <b>default</b> {@link File#compareTo(File)} method. 254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * This comparator can be used to sort lists or arrays of files 274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * by using the default file comparison. 284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example of sorting a list of files using the 304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * {@link #DEFAULT_COMPARATOR} singleton instance: 314fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 324fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * List<File> list = ... 334fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Collections.sort(list, DefaultFileComparator.DEFAULT_COMPARATOR); 344fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * </pre> 354fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 364fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example of doing a <i>reverse</i> sort of an array of files using the 374fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * {@link #DEFAULT_REVERSE} singleton instance: 384fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File[] array = ... 404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Arrays.sort(array, DefaultFileComparator.DEFAULT_REVERSE); 414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * </pre> 424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 434fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 444fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @version $Revision: 609243 $ $Date: 2008-01-06 00:30:42 +0000 (Sun, 06 Jan 2008) $ 454fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @since Commons IO 1.4 464fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 474fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypublic class DefaultFileComparator implements Comparator<File>, Serializable { 484fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 494fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton default comparator instance */ 504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final Comparator<File> DEFAULT_COMPARATOR = new DefaultFileComparator(); 514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton reverse default comparator instance */ 534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final Comparator<File> DEFAULT_REVERSE = new ReverseComparator<File>(DEFAULT_COMPARATOR); 544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 554fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 564fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Compare the two files using the {@link File#compareTo(File)} method. 574fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 584fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param obj1 The first file to compare 594fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param obj2 The second file to compare 604fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return the result of calling file1's 614fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * {@link File#compareTo(File)} with file2 as the parameter. 624fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 634fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public int compare(File file1, File file2) { 644fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return file1.compareTo(file2); 654fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 664fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy} 67