com.signalfx.shaded.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 com.signalfx.shaded.apache.commons.io.filefilter;
import java.io.File;
import java.io.Serializable;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.attribute.BasicFileAttributes;
/**
* This filter accepts {@code File}s that can be written to.
*
* Example, showing how to print out a list of the current directory's writable files:
*
* Using Classic IO
*
* File dir = new File(".");
* String[] files = dir.list(CanWriteFileFilter.CAN_WRITE);
* for (String file : files) {
* System.out.println(file);
* }
*
*
*
* 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 (String file : files) {
* System.out.println(file);
* }
*
*
*
* N.B. For read-only files, use {@code CanReadFileFilter.READ_ONLY}.
*
* @since 1.3
*/
public class CanWriteFileFilter extends AbstractFileFilter implements Serializable {
/** 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 = CAN_WRITE.negate();
private static final long serialVersionUID = 5132005214688990379L;
/**
* Restrictive constructor.
*/
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();
}
/**
* 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}.
* @since 2.9.0
*/
@Override
public FileVisitResult accept(final Path file, final BasicFileAttributes attributes) {
return toFileVisitResult(Files.isWritable(file), file);
}
}