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.filefilter; 184fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 194fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.File; 204fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedyimport java.io.Serializable; 214fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 224fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy/** 234fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * This filter accepts <code>File</code>s that can be read. 244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example, showing how to print out a list of the 264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * current directory's <i>readable</i> files: 274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File dir = new File("."); 304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * String[] files = dir.list( CanReadFileFilter.CAN_READ ); 314fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * for ( int i = 0; i < files.length; i++ ) { 324fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * System.out.println(files[i]); 334fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * } 344fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * </pre> 354fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 364fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 374fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example, showing how to print out a list of the 384fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * current directory's <i>un-readable</i> files: 394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File dir = new File("."); 424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * String[] files = dir.list( CanReadFileFilter.CANNOT_READ ); 434fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * for ( int i = 0; i < files.length; i++ ) { 444fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * System.out.println(files[i]); 454fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * } 464fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * </pre> 474fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 484fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 494fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example, showing how to print out a list of the 504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * current directory's <i>read-only</i> files: 514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File dir = new File("."); 544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * String[] files = dir.list( CanReadFileFilter.READ_ONLY ); 554fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * for ( int i = 0; i < files.length; i++ ) { 564fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * System.out.println(files[i]); 574fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * } 584fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * </pre> 594fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 604fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @since Commons IO 1.3 614fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @version $Revision: 587916 $ 624fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 634fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypublic class CanReadFileFilter extends AbstractFileFilter implements Serializable { 644fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 654fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton instance of <i>readable</i> filter */ 664fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final IOFileFilter CAN_READ = new CanReadFileFilter(); 674fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 684fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton instance of not <i>readable</i> filter */ 694fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final IOFileFilter CANNOT_READ = new NotFileFilter(CAN_READ); 704fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 714fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton instance of <i>read-only</i> filter */ 724fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final IOFileFilter READ_ONLY = new AndFileFilter(CAN_READ, 734fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy CanWriteFileFilter.CANNOT_WRITE); 744fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 754fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 764fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Restrictive consructor. 774fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 784fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy protected CanReadFileFilter() { 794fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 804fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 814fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 824fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Checks to see if the file can be read. 834fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 844fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param file the File to check. 854fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return <code>true</code> if the file can be 864fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * read, otherwise <code>false</code>. 874fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 884fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public boolean accept(File file) { 894fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return file.canRead(); 904fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 914fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 924fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy} 93