Commons IO example source code file (HiddenFileFilter.java)

This example Commons IO source code file (HiddenFileFilter.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Commons IO tags/keywords

abstractfilefilter, abstractfilefilter, hidden, hiddenfilefilter, hiddenfilefilter, io, iofilefilter, iofilefilter, notfilefilter, override, serializable, visible, visible

The Commons IO HiddenFileFilter.java source code

/*
 * 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.Serializable;

/**
 * This filter accepts <code>Files that are hidden.
 * <p>
 * Example, showing how to print out a list of the
 * current directory's <i>hidden files:
 *
 * <pre>
 * File dir = new File(".");
 * String[] files = dir.list( HiddenFileFilter.HIDDEN );
 * for ( int i = 0; i < files.length; i++ ) {
 *     System.out.println(files[i]);
 * }
 * </pre>
 *
 * <p>
 * Example, showing how to print out a list of the
 * current directory's <i>visible (i.e. not hidden) files:
 *
 * <pre>
 * File dir = new File(".");
 * String[] files = dir.list( HiddenFileFilter.VISIBLE );
 * for ( int i = 0; i < files.length; i++ ) {
 *     System.out.println(files[i]);
 * }
 * </pre>
 *
 * @since Commons IO 1.3
 * @version $Revision: 659817 $
 */
public class HiddenFileFilter extends AbstractFileFilter implements Serializable {
    
    /** Singleton instance of <i>hidden filter */
    public static final IOFileFilter HIDDEN  = new HiddenFileFilter();
    
    /** Singleton instance of <i>visible filter */
    public static final IOFileFilter VISIBLE = new NotFileFilter(HIDDEN);
    
    /**
     * Restrictive consructor.
     */
    protected HiddenFileFilter() {
    }
    
    /**
     * Checks to see if the file is hidden.
     * 
     * @param file  the File to check
     * @return <code>true if the file is
     *  <i>hidden, otherwise false.
     */
    @Override
    public boolean accept(File file) {
        return file.isHidden();
    }
    
}