com.groupbyinc.common.apache.commons.io.filefilter.CanWriteFileFilter Maven / Gradle / Ivy
/*
* 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.filefilter;
import java.io.File;
import java.io.Serializable;
/**
* This filter accepts Files that can be written to.
*
* Example, showing how to print out a list of the
* current directory's writable files:
*
*
* File dir = new File(".");
* String[] files = dir.list( CanWriteFileFilter.CAN_WRITE );
* for ( int i = 0; i < files.length; i++ ) {
* System.out.println(files[i]);
* }
*
*
*
* Example, showing how to print out a list of the
* current directory's un-writable files:
*
*
* File dir = new File(".");
* String[] files = dir.list( CanWriteFileFilter.CANNOT_WRITE );
* for ( int i = 0; i < files.length; i++ ) {
* System.out.println(files[i]);
* }
*
*
*
* N.B. For read-only files, use
* CanReadFileFilter.READ_ONLY.
*
* @since 1.3
* @version $Id: CanWriteFileFilter.java 1642757 2014-12-01 21:09:30Z sebb $
*/
public class CanWriteFileFilter extends AbstractFileFilter implements Serializable {
private static final long serialVersionUID = 5132005214688990379L;
/** Singleton instance of writable filter */
public static final IOFileFilter CAN_WRITE = new CanWriteFileFilter();
/** Singleton instance of not writable filter */
public static final IOFileFilter CANNOT_WRITE = new NotFileFilter(CAN_WRITE);
/**
* Restrictive consructor.
*/
protected CanWriteFileFilter() {
}
/**
* Checks to see if the file can be written to.
*
* @param file the File to check
* @return {@code true} if the file can be
* written to, otherwise {@code false}.
*/
@Override
public boolean accept(final File file) {
return file.canWrite();
}
}