Package org.apache.tools.ant.taskdefs
Class Chmod
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.ExecTask
- 
- org.apache.tools.ant.taskdefs.ExecuteOn
- 
- org.apache.tools.ant.taskdefs.Chmod
 
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 
 public class Chmod extends ExecuteOn Chmod equivalent for unix-like environments.- Since:
- Ant 1.1
- To do:
- Refactor so it does not extend from ExecuteOn and then turn around and unsupport several attributes.
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOnExecuteOn.FileDirBoth
 
- 
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOndestDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
 - 
Fields inherited from class org.apache.tools.ant.taskdefs.ExecTaskcmdl, failOnError, newEnvironment, redirector, redirectorElement
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description Chmod()Chmod task for setting file and directory permissions.
 - 
Method SummaryModifier and Type Method Description protected voidcheckConfiguration()Check the attributes and nested elements.PatternSet.NameEntrycreateExclude()Add a name entry on the exclude list.PatternSet.NameEntrycreateInclude()Add a name entry on the include list.PatternSetcreatePatternSet()Add a set of patterns.voidexecute()Carry out the chmoding.protected booleanisValidOs()Check if the os is valid.voidsetAddsourcefile(boolean b)This is not allowed for Chmod.voidsetCommand(Commandline cmdl)Set the command.voidsetDefaultexcludes(boolean useDefaultExcludes)Sets whether default exclusions should be used or not.voidsetDir(java.io.File src)The directory which holds the files whose permissions must be changed.voidsetExcludes(java.lang.String excludes)Sets the set of exclude patterns.voidsetExecutable(java.lang.String e)Set the executable.voidsetFile(java.io.File src)The file or single directory of which the permissions must be changed.voidsetIncludes(java.lang.String includes)Sets the set of include patterns.voidsetPerm(java.lang.String perm)Set the new permissions.voidsetProject(Project project)Set the project of this task.voidsetSkipEmptyFilesets(boolean skip)This is not allowed for Chmod.- 
Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOnadd, add, addDirset, addFilelist, addFileset, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setType, setupRedirector, setVerbose
 - 
Methods inherited from class org.apache.tools.ant.taskdefs.ExecTaskaddConfiguredRedirector, addEnv, createArg, createWatchdog, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setError, setErrorProperty, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
 - 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation
 
- 
 
- 
- 
- 
Method Detail- 
setProjectpublic void setProject(Project project) Set the project of this task. Calls the super class and sets the project on dhe default FileSet.- Overrides:
- setProjectin class- ProjectComponent
- Parameters:
- project- the project for this task.
- See Also:
- ProjectComponent.setProject(org.apache.tools.ant.Project)
 
 - 
setFilepublic void setFile(java.io.File src) The file or single directory of which the permissions must be changed.- Parameters:
- src- the source file or directory.
 
 - 
setDirpublic void setDir(java.io.File src) The directory which holds the files whose permissions must be changed.
 - 
setPermpublic void setPerm(java.lang.String perm) Set the new permissions.- Parameters:
- perm- the new permissions.
 
 - 
createIncludepublic PatternSet.NameEntry createInclude() Add a name entry on the include list.- Returns:
- a NameEntry to be configured.
 
 - 
createExcludepublic PatternSet.NameEntry createExclude() Add a name entry on the exclude list.- Returns:
- a nameentry to be configured.
 
 - 
createPatternSetpublic PatternSet createPatternSet() Add a set of patterns.- Returns:
- a patternset to be configured.
 
 - 
setIncludespublic void setIncludes(java.lang.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.
 
 - 
setExcludespublic void setExcludes(java.lang.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.
 
 - 
setDefaultexcludespublic 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.
 
 - 
checkConfigurationprotected void checkConfiguration() Check the attributes and nested elements.- Overrides:
- checkConfigurationin class- ExecuteOn
 
 - 
executepublic void execute() throws BuildExceptionCarry out the chmoding.- Overrides:
- executein class- ExecTask
- Throws:
- BuildException- on error.
 
 - 
setExecutablepublic void setExecutable(java.lang.String e) Set the executable. This is not allowed for Chmod.- Overrides:
- setExecutablein class- ExecTask
- Parameters:
- e- ignored.
- Throws:
- BuildException- always.
 
 - 
setCommandpublic void setCommand(Commandline cmdl) Set the command. This is not allowed for Chmod.- Overrides:
- setCommandin class- ExecTask
- Parameters:
- cmdl- ignored.
- Throws:
- BuildException- always.
 
 - 
setSkipEmptyFilesetspublic void setSkipEmptyFilesets(boolean skip) This is not allowed for Chmod.- Overrides:
- setSkipEmptyFilesetsin class- ExecuteOn
- Parameters:
- skip- ignored.
- Throws:
- BuildException- always.
 
 - 
setAddsourcefilepublic void setAddsourcefile(boolean b) This is not allowed for Chmod.- Overrides:
- setAddsourcefilein class- ExecuteOn
- Parameters:
- b- ignored.
- Throws:
- BuildException- always.
 
 
- 
 
-