DeletedFileFilter.java

/*
 * The MIT License
 *
 * Copyright 2013 Mirko Friedenhagen.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package hudson.plugins.jobConfigHistory;

import java.io.File;
import java.io.FileFilter;

/**
 * A filter to return only those directories of a file listing that represent
 * deleted jobs history directories, the names of which contain
 * {@link JobConfigHistoryConsts#DELETED_MARKER}.
 *
 * @author Mirko Friedenhagen
 */
public class DeletedFileFilter implements FileFilter {

	/** name of history xml file. */
	public static final String DELETED_MARKER = "_deleted_";

	/** Only one instance needed. */
	public static final DeletedFileFilter INSTANCE = new DeletedFileFilter();

	@Override
	public boolean accept(File file) {
		return accept(file.getName());
	}

	/**
	 * Deleted?
	 *
	 * @param fileName
	 *            to inspect
	 * @return true when fileName has the special deleted mark.
	 */
	private boolean accept(final String fileName) {
		return fileName.contains(DELETED_MARKER);
	}

	/**
	 * Is this item deleted?
	 *
	 * @param file
	 *            to inspect
	 * @return true when file has the special deleted mark.
	 */
	public static boolean accepts(File file) {
		return INSTANCE.accept(file);
	}

	/**
	 * Is this item deleted?
	 *
	 * @param fileName
	 *            to inspect
	 * @return true when fileName has the special deleted mark.
	 */
	public static boolean accepts(String fileName) {
		return INSTANCE.accept(fileName);
	}

}