org.apache.tools.ant.taskdefs

Class Chmod

public class Chmod extends ExecuteOn

Chmod equivalent for unix-like environments.

Since: Ant 1.1

UNKNOWN: category="filesystem" Refactor so it does not extend from ExecuteOn and then turn around and unsupport several attributes.

Constructor Summary
	Chmod() Chmod task for setting file and directory permissions.

Method Summary
protected void	checkConfiguration() Check the attributes and nested elements.
PatternSet.NameEntry	createExclude() Add a name entry on the exclude list.
PatternSet.NameEntry	createInclude() Add a name entry on the include list.
PatternSet	createPatternSet() Add a set of patterns.
void	execute() Carry out the chmoding.
protected boolean	isValidOs() Check if the os is valid.
void	setAddsourcefile(boolean b) This is not allowed for Chmod.
void	setCommand(Commandline cmdl) Set the command.
void	setDefaultexcludes(boolean useDefaultExcludes) Sets whether default exclusions should be used or not.
void	setDir(File src) The directory which holds the files whose permissions must be changed.
void	setExcludes(String excludes) Sets the set of exclude patterns.
void	setExecutable(String e) Set the executable.
void	setFile(File src) The file or single directory of which the permissions must be changed.
void	setIncludes(String includes) Sets the set of include patterns.
void	setPerm(String perm) Set the new permissions.
void	setProject(Project project) Set the project of this task.
void	setSkipEmptyFilesets(boolean skip) This is not allowed for Chmod.

Constructor Detail

Chmod

public Chmod()

Chmod task for setting file and directory permissions.

Method Detail

checkConfiguration

protected void checkConfiguration()

Check the attributes and nested elements.

createExclude

public PatternSet.NameEntry createExclude()

Add a name entry on the exclude list.

Returns: a nameentry to be configured.

createInclude

public PatternSet.NameEntry createInclude()

Add a name entry on the include list.

Returns: a NameEntry to be configured.

createPatternSet

public PatternSet createPatternSet()

Add a set of patterns.

Returns: a patternset to be configured.

execute

public void execute()

Carry out the chmoding.

Throws: BuildException on error.

isValidOs

protected boolean isValidOs()

Check if the os is valid. Always include unix.

Returns: true if the os is valid.

setAddsourcefile

public void setAddsourcefile(boolean b)

This is not allowed for Chmod.

Parameters: b ignored.

Throws: BuildException always.

UNKNOWN: ignore="true"

setCommand

public void setCommand(Commandline cmdl)

Set the command. This is not allowed for Chmod.

Parameters: cmdl ignored.

Throws: BuildException always.

UNKNOWN: ignore="true"

setDefaultexcludes

public void setDefaultexcludes(boolean useDefaultExcludes)

Sets whether default exclusions should be used or not.

Parameters: useDefaultExcludes "true"|"on"|"yes" when default exclusions should be used, "false"|"off"|"no" when they shouldn't be used.

setDir

public void setDir(File src)

The directory which holds the files whose permissions must be changed.

Parameters: src the directory.

setExcludes

public void setExcludes(String excludes)

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Parameters: excludes the string containing the exclude patterns.

setExecutable

public void setExecutable(String e)

Set the executable. This is not allowed for Chmod.

Parameters: e ignored.

Throws: BuildException always.

UNKNOWN: ignore="true"

setFile

public void setFile(File src)

The file or single directory of which the permissions must be changed.

Parameters: src the source file or directory.

setIncludes

public void setIncludes(String includes)

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Parameters: includes the string containing the include patterns.

setPerm

public void setPerm(String perm)

Set the new permissions.

Parameters: perm the new permissions.

setProject

public void setProject(Project project)

Set the project of this task. Calls the super class and sets the project on dhe default FileSet.

Parameters: project the project for this task.

setSkipEmptyFilesets

public void setSkipEmptyFilesets(boolean skip)

This is not allowed for Chmod.

Parameters: skip ignored.

Throws: BuildException always.

UNKNOWN: ignore="true"