SizeFileFilter.java
- /*
- * 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.IOException;
- 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;
- /**
- * Filters files based on size, can filter either smaller files or
- * files equal to or larger than a given threshold.
- * <p>
- * For example, to print all files and directories in the
- * current directory whose size is greater than 1 MB:
- * </p>
- * <h2>Using Classic IO</h2>
- * <pre>
- * File dir = FileUtils.current();
- * String[] files = dir.list(new SizeFileFilter(1024 * 1024));
- * for (String file : files) {
- * System.out.println(file);
- * }
- * </pre>
- *
- * <h2>Using NIO</h2>
- * <pre>
- * final Path dir = PathUtils.current();
- * final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new SizeFileFilter(1024 * 1024));
- * //
- * // Walk one directory
- * Files.<strong>walkFileTree</strong>(dir, Collections.emptySet(), 1, visitor);
- * System.out.println(visitor.getPathCounters());
- * System.out.println(visitor.getFileList());
- * //
- * visitor.getPathCounters().reset();
- * //
- * // Walk directory tree
- * Files.<strong>walkFileTree</strong>(dir, visitor);
- * System.out.println(visitor.getPathCounters());
- * System.out.println(visitor.getDirList());
- * System.out.println(visitor.getFileList());
- * </pre>
- * <h2>Deprecating Serialization</h2>
- * <p>
- * <em>Serialization is deprecated and will be removed in 3.0.</em>
- * </p>
- *
- * @since 1.2
- * @see FileFilterUtils#sizeFileFilter(long)
- * @see FileFilterUtils#sizeFileFilter(long, boolean)
- * @see FileFilterUtils#sizeRangeFileFilter(long, long)
- */
- public class SizeFileFilter extends AbstractFileFilter implements Serializable {
- private static final long serialVersionUID = 7388077430788600069L;
- /** Whether the files accepted will be larger or smaller. */
- private final boolean acceptLarger;
- /** The size threshold. */
- private final long size;
- /**
- * Constructs a new size file filter for files equal to or
- * larger than a certain size.
- *
- * @param size the threshold size of the files
- * @throws IllegalArgumentException if the size is negative
- */
- public SizeFileFilter(final long size) {
- this(size, true);
- }
- /**
- * Constructs a new size file filter for files based on a certain size
- * threshold.
- *
- * @param size the threshold size of the files
- * @param acceptLarger if true, files equal to or larger are accepted,
- * otherwise smaller ones (but not equal to)
- * @throws IllegalArgumentException if the size is negative
- */
- public SizeFileFilter(final long size, final boolean acceptLarger) {
- if (size < 0) {
- throw new IllegalArgumentException("The size must be non-negative");
- }
- this.size = size;
- this.acceptLarger = acceptLarger;
- }
- /**
- * Checks to see if the size of the file is favorable.
- * <p>
- * If size equals threshold and smaller files are required,
- * file <strong>IS NOT</strong> selected.
- * If size equals threshold and larger files are required,
- * file <strong>IS</strong> selected.
- * </p>
- *
- * @param file the File to check
- * @return true if the file name matches
- */
- @Override
- public boolean accept(final File file) {
- return accept(file != null ? file.length() : 0);
- }
- private boolean accept(final long length) {
- return acceptLarger != length < size;
- }
- /**
- * Checks to see if the size of the file is favorable.
- * <p>
- * If size equals threshold and smaller files are required, file <strong>IS NOT</strong> selected. If size equals threshold and larger files are required,
- * file <strong>IS</strong> selected.
- * </p>
- *
- * @param file the File to check
- * @param attributes the path's basic attributes (may be null).
- * @return true if the file name matches
- */
- @Override
- public FileVisitResult accept(final Path file, final BasicFileAttributes attributes) {
- return get(() -> toFileVisitResult(accept(Files.size(file))));
- }
- /**
- * Provide a String representation of this file filter.
- *
- * @return a String representation
- */
- @Override
- public String toString() {
- final String condition = acceptLarger ? ">=" : "<";
- return super.toString() + "(" + condition + size + ")";
- }
- @Override
- public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs) throws IOException {
- return toFileVisitResult(accept(Files.size(file)));
- }
- }