/*
 * FileNameRegexFilter class.
 *
 * Copyright (C) 2007 SATOH Takayuki All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package ts.util.file;

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

/**
 * ファイル名に対する正規表現を条件とするファイル・フィルタ・クラス。
 *
 * @author  佐藤隆之.
 * @version $Revision: 1.1.1.1 $, $Date: 2010-10-16 00:03:46 $
 */
public class FileNameRegexFilter implements FileFilter
{
  /** ファイル名に対する正規表現。 */
  private String fileNameRegex_ ;

  /**
   * ファイル名に対する正規表現を引数にとるコンストラクタ。
   *
   * @param regex 正規表現。
   * @throws AssertionError 引数がヌルの場合（デバッグ・モードのみ）。
   */
  public FileNameRegexFilter(String regex)
  {
    assert (regex != null) : "@param:regex is null.";

    fileNameRegex_ = regex;
  }

  /**
   * 指定されたファイルの名前が、このオブジェクトの示す正規表現に合致するか
   * どうかを判定する。
   *
   * @param  file 判定対象のファイル。
   * @return ファイルの名前が正規表現に合致する場合は<tt>true</tt>を返す。
   * @throws AssertionError 引数がヌルの場合（デバッグ・モードのみ）。
   */
  public boolean accept(File file)
  {
    assert (file != null) : "@param:file is null.";

    return file.getName().matches(fileNameRegex_);
  }
}

