com.izforge.izpack.util.file.types

Class FileList

java.lang.Object

com.izforge.izpack.util.file.types.DataType

com.izforge.izpack.util.file.types.FileList

public class FileList
extends DataType

FileList represents an explicitly named list of files. FileLists are useful when you want to capture a list of files regardless of whether they currently exist. By contrast, FileSet operates as a filter, only returning the name of a matched file if it currently exists in the file system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileList.FileName Inner class corresponding to the <file> nested element.

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileList() The default constructor.
protected	FileList(FileList filelist) A copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addConfiguredFile(FileList.FileName name) Add a nested <file> nested element.
File	getDir()
String[]	getFiles() Returns the list of files represented by this FileList.
void	setDir(File dir) Set the dir attribute.
void	setFiles(String filenames) Set the filenames attribute.

Methods inherited from class com.izforge.izpack.util.file.types.DataType

getDescription, isChecked, noChildrenAllowed, setChecked, setDescription, tooManyAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileList

public FileList()

The default constructor.

FileList

protected FileList(FileList filelist)

A copy constructor.

Parameters:

filelist - a FileList value

Method Detail

setDir

public void setDir(File dir)
            throws Exception

Set the dir attribute.

Parameters:

dir - the directory this filelist is relative to.

Throws:

Exception - if an error occurs

getDir

public File getDir()

Returns:

the directory attribute

setFiles

public void setFiles(String filenames)

Set the filenames attribute.

Parameters:

filenames - a string contains filenames, separated by , or by whitespace.

getFiles

public String[] getFiles()
                  throws Exception

Returns the list of files represented by this FileList.

Parameters:

p - the current project

Returns:

the list of files represented by this FileList.

Throws:

Exception

addConfiguredFile

public void addConfiguredFile(FileList.FileName name)
                       throws Exception

Add a nested <file> nested element.

Parameters:

name - a configured file element with a name.

Throws:

Exception