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 written to. 244fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <p> 254fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Example, showing how to print out a list of the 264fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * current directory's <i>writable</i> files: 274fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 284fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 294fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File dir = new File("."); 304fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * String[] files = dir.list( CanWriteFileFilter.CAN_WRITE ); 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-writable</i> files: 394fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 404fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <pre> 414fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * File dir = new File("."); 424fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * String[] files = dir.list( CanWriteFileFilter.CANNOT_WRITE ); 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 * <b>N.B.</b> For read-only files, use 504fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * <code>CanReadFileFilter.READ_ONLY</code>. 514fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 524fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @since Commons IO 1.3 534fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @version $Revision: 587916 $ 544fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 554fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedypublic class CanWriteFileFilter extends AbstractFileFilter implements Serializable { 564fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 574fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton instance of <i>writable</i> filter */ 584fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final IOFileFilter CAN_WRITE = new CanWriteFileFilter(); 594fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 604fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** Singleton instance of not <i>writable</i> filter */ 614fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public static final IOFileFilter CANNOT_WRITE = new NotFileFilter(CAN_WRITE); 624fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 634fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 644fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Restrictive consructor. 654fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 664fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy protected CanWriteFileFilter() { 674fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 684fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 694fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy /** 704fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * Checks to see if the file can be written to. 714fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * 724fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @param file the File to check 734fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * @return <code>true</code> if the file can be 744fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy * written to, otherwise <code>false</code>. 754fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy */ 764fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy public boolean accept(File file) { 774fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy return file.canWrite(); 784fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy } 794fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy 804fa0a3295bcacbdcd6a9e7709cf17aa5adb90356Scott Kennedy} 81