001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017
018package org.apache.logging.log4j.core.appender.rolling.action;
019
020import java.io.IOException;
021import java.nio.file.FileVisitResult;
022import java.nio.file.Path;
023import java.nio.file.SimpleFileVisitor;
024import java.nio.file.attribute.BasicFileAttributes;
025import java.util.ArrayList;
026import java.util.Collections;
027import java.util.List;
028import java.util.Objects;
029
030/**
031 * FileVisitor that sorts files.
032 */
033public class SortingVisitor extends SimpleFileVisitor<Path> {
034
035    private final PathSorter sorter;
036    private final List<PathWithAttributes> collected = new ArrayList<>();
037
038    /**
039     * Constructs a new DeletingVisitor.
040     *
041     * @param basePath used to relativize paths
042     * @param pathFilters objects that need to confirm whether a file can be deleted
043     */
044    public SortingVisitor(final PathSorter sorter) {
045        this.sorter = Objects.requireNonNull(sorter, "sorter");
046    }
047
048    @Override
049    public FileVisitResult visitFile(final Path path, final BasicFileAttributes attrs) throws IOException {
050        collected.add(new PathWithAttributes(path, attrs));
051        return FileVisitResult.CONTINUE;
052    }
053
054    public List<PathWithAttributes> getSortedPaths() {
055        Collections.sort(collected, sorter);
056        return collected;
057    }
058}