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 * https://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 import java.nio.file.FileVisitResult;
22 import java.nio.file.Files;
23 import java.nio.file.Path;
24 import java.nio.file.attribute.BasicFileAttributes;
25
26 /**
27 * This filter accepts {@link File}s that are writable.
28 * <p>
29 * Example, showing how to print out a list of the current directory's <em>writable</em> files:
30 * </p>
31 * <h2>Using Classic IO</h2>
32 * <pre>
33 * File dir = FileUtils.current();
34 * String[] files = dir.list(CanWriteFileFilter.CAN_WRITE);
35 * for (String file : files) {
36 * System.out.println(file);
37 * }
38 * </pre>
39 * <p>
40 * Example, showing how to print out a list of the current directory's <em>un-writable</em> files:
41 * </p>
42 * <pre>
43 * File dir = FileUtils.current();
44 * String[] files = dir.list(CanWriteFileFilter.CANNOT_WRITE);
45 * for (String file : files) {
46 * System.out.println(file);
47 * }
48 * </pre>
49 * <p>
50 * <strong>N.B.</strong> For read-only files, use {@code CanReadFileFilter.READ_ONLY}.
51 * </p>
52 * <h2>Deprecating Serialization</h2>
53 * <p>
54 * <em>Serialization is deprecated and will be removed in 3.0.</em>
55 * </p>
56 *
57 * @see Files#isWritable(Path)
58 * @since 1.3
59 */
60 public class CanWriteFileFilter extends AbstractFileFilter implements Serializable {
61
62 /** Singleton instance of <em>writable</em> filter */
63 public static final IOFileFilter CAN_WRITE = new CanWriteFileFilter();
64
65 /** Singleton instance of not <em>writable</em> filter */
66 public static final IOFileFilter CANNOT_WRITE = CAN_WRITE.negate();
67
68 private static final long serialVersionUID = 5132005214688990379L;
69
70 /**
71 * Restrictive constructor.
72 */
73 protected CanWriteFileFilter() {
74 }
75
76 /**
77 * Tests to see if the file can be written to.
78 *
79 * @param file the File to check.
80 * @return {@code true} if the file can be written to, otherwise {@code false}.
81 */
82 @Override
83 public boolean accept(final File file) {
84 return file != null && file.canWrite();
85 }
86
87 /**
88 * Tests to see if the file can be written to.
89 *
90 * @param file the File to check.
91 * @param attributes the path's basic attributes (may be null).
92 * @return {@code true} if the file can be written to, otherwise {@code false}.
93 * @since 2.9.0
94 */
95 @Override
96 public FileVisitResult accept(final Path file, final BasicFileAttributes attributes) {
97 return toFileVisitResult(file != null && Files.isWritable(file));
98 }
99
100 }