1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this file to You under the Apache License, Version 2.0 6 * (the "License"); you may not use this file except in compliance with 7 * the License. You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 package org.apache.commons.io.filefilter; 18 19 import java.io.File; 20 import java.io.Serializable; 21 22 /** 23 * This filter accepts <code>File</code>s that can be written to. 24 * <p> 25 * Example, showing how to print out a list of the 26 * current directory's <i>writable</i> files: 27 * 28 * <pre> 29 * File dir = new File("."); 30 * String[] files = dir.list( CanWriteFileFilter.CAN_WRITE ); 31 * for ( int i = 0; i < files.length; i++ ) { 32 * System.out.println(files[i]); 33 * } 34 * </pre> 35 * 36 * <p> 37 * Example, showing how to print out a list of the 38 * current directory's <i>un-writable</i> files: 39 * 40 * <pre> 41 * File dir = new File("."); 42 * String[] files = dir.list( CanWriteFileFilter.CANNOT_WRITE ); 43 * for ( int i = 0; i < files.length; i++ ) { 44 * System.out.println(files[i]); 45 * } 46 * </pre> 47 * 48 * <p> 49 * <b>N.B.</b> For read-only files, use 50 * <code>CanReadFileFilter.READ_ONLY</code>. 51 * 52 * @since Commons IO 1.3 53 * @version $Revision: 587916 $ 54 */ 55 public class CanWriteFileFilter extends AbstractFileFilter implements Serializable { 56 57 /** Singleton instance of <i>writable</i> filter */ 58 public static final IOFileFilter CAN_WRITE = new CanWriteFileFilter(); 59 60 /** Singleton instance of not <i>writable</i> filter */ 61 public static final IOFileFilter CANNOT_WRITE = new NotFileFilter(CAN_WRITE); 62 63 /** 64 * Restrictive consructor. 65 */ 66 protected CanWriteFileFilter() { 67 } 68 69 /** 70 * Checks to see if the file can be written to. 71 * 72 * @param file the File to check 73 * @return <code>true</code> if the file can be 74 * written to, otherwise <code>false</code>. 75 */ 76 public boolean accept(File file) { 77 return file.canWrite(); 78 } 79 80 } 81
