/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * foo.java
 *
 * Created on November 11, 2001, 12:09 AM
 */

package com.sun.enterprise.config.backup.util;
import java.io.*;
import java.util.*;

/**
 *
 * @author  bnevins
 * @version
 */
public abstract class FileLister
{
    abstract protected boolean relativePath();
    
    ///////////////////////////////////////////////////////////////////////////
    
    FileLister(File root)
    {
        mainRoot = root;
        fileList = new ArrayList();
    }
    
    /**
     * Normally, we don't want a list of empty (leaf) directories.  In case this
     * is desired -- call this method.  The default is to NOT keep empty directories
     * in the list
     */
    public void keepEmptyDirectories()
    {
        keepEmpty = true;
    }
    
    ///////////////////////////////////////////////////////////////////////////
    
    public String[] getFiles()
    {
        getFilesInternal(mainRoot);
        String[] files = new String[fileList.size()];
        
        if(files.length <= 0)
            return files;
        
        int len = 0;
        
        if(relativePath())
            len = mainRoot.getPath().length() + 1;
        
        for(int i = 0; i < files.length; i++)
        {
            files[i] = ((File)fileList.get(i)).getPath().substring(len).replace('\\', '/');
        }
        
        Arrays.sort(files, String.CASE_INSENSITIVE_ORDER);
        return files;
    }
    
    ///////////////////////////////////////////////////////////////////////////
    
    private void getFilesInternal(File root)
    {
        File[] files = root.listFiles();
        
        for(int i = 0; i < files.length; i++)
        {
            if(files[i].isDirectory())
            {
                getFilesInternal(files[i]);
            }
            else
                fileList.add(files[i]);	// actual file
        }
        
        // add empty directory, if the option is turned on
        if(files.length <= 0 && keepEmpty)
            fileList.add(root);
    }
    
    ///////////////////////////////////////////////////////////////////////////
    
    private	ArrayList	fileList	= null;
    private File		mainRoot	= null;
    private boolean		keepEmpty	= false;
}