org.acmsl.antmake
Class AntMakeTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.MatchingTask
                    |
                    +--org.acmsl.antmake.AntMakeTask
All Implemented Interfaces:
org.apache.tools.ant.types.selectors.SelectorContainer

public class AntMakeTask
extends org.apache.tools.ant.taskdefs.MatchingTask

Generates required files to build a Java project using GNU Autoconf, Automake and libtool.

Version:
$Revision: 1.9 $
Author:
Jose San Leandro

Field Summary
 
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
fileset, useDefaultExcludes
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
AntMakeTask()
          Creates a AntMakeTask.
 
Method Summary
 org.apache.tools.ant.types.Path createClasspath()
          Creates the classpath.
 org.apache.tools.ant.types.Path createLiblicensepath()
          Creates the library licenses path.
 org.apache.tools.ant.types.Path createSourcepath()
          Creates the source-roots path.
 void execute()
          Requests the AntMake generation process to be performed.
 java.io.File getAuthorsfile()
          Retrieves the AUTHORS file.
 org.apache.tools.ant.types.Path getClasspath()
          Retrieves the classpath.
 java.io.File getCopyingfile()
          Retrieves the COPYING file.
 java.io.File getDestinationfolder()
          Retrieves the destination folder.
 org.apache.tools.ant.types.Path getLiblicensepath()
          Retrieves the library licenses path.
 java.lang.String getProjectname()
          Retrieves the project name.
 java.lang.String getProjectversion()
          Retrieves the project version.
 java.io.File getReadmefile()
          Retrieves the README file.
 org.apache.tools.ant.types.Path getSourcepath()
          Retrieves the sourcepath.
 void setAuthorsfile(java.io.File authors)
          Specifies the AUTHORS file.
 void setClasspath(org.apache.tools.ant.types.Path classpath)
          Specifies the classpath.
 void setClasspathref(org.apache.tools.ant.types.Reference ref)
          Specifies the classpath reference.
 void setCopyingfile(java.io.File copying)
          Specifies the COPYING file.
 void setDestinationfolder(java.io.File destination)
          Specifies the destination folder.
 void setLiblicensepath(org.apache.tools.ant.types.Path liblicensepath)
          Specifies the library licenses path.
 void setLiblicensepathref(org.apache.tools.ant.types.Reference ref)
          Specifies the library licenses path reference.
 void setProjectname(java.lang.String name)
          Specifies the project name.
 void setProjectversion(java.lang.String version)
          Specifies the project version.
 void setReadmefile(java.io.File readme)
          Specifies the README file.
 void setSourcepath(org.apache.tools.ant.types.Path sourcepath)
          Specifies the sourcepath.
 void setSourcepathref(org.apache.tools.ant.types.Reference ref)
          Specifies the sourcepath reference.
protected  void validateParameters()
          Validates the parameters given.
 
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
addAnd, addContains, addCustom, addDate, addDepend, addDepth, addFilename, addMajority, addNone, addNot, addOr, addPresent, addSelector, addSize, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AntMakeTask

public AntMakeTask()
Creates a AntMakeTask.

Method Detail

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path sourcepath)
Specifies the sourcepath.

Parameters:
sourcepath - such path.

getSourcepath

public org.apache.tools.ant.types.Path getSourcepath()
Retrieves the sourcepath.

Returns:
such path.

createSourcepath

public org.apache.tools.ant.types.Path createSourcepath()
Creates the source-roots path.

Returns:
such path.

setSourcepathref

public void setSourcepathref(org.apache.tools.ant.types.Reference ref)
Specifies the sourcepath reference.

Parameters:
ref - such reference.

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)
Specifies the classpath.

Parameters:
classpath - such path.

getClasspath

public org.apache.tools.ant.types.Path getClasspath()
Retrieves the classpath.

Returns:
such path.

createClasspath

public org.apache.tools.ant.types.Path createClasspath()
Creates the classpath.

Returns:
such path.

setClasspathref

public void setClasspathref(org.apache.tools.ant.types.Reference ref)
Specifies the classpath reference.

Parameters:
ref - such reference.

setLiblicensepath

public void setLiblicensepath(org.apache.tools.ant.types.Path liblicensepath)
Specifies the library licenses path.

Parameters:
liblicensepath - such path.

getLiblicensepath

public org.apache.tools.ant.types.Path getLiblicensepath()
Retrieves the library licenses path.

Returns:
such path.

createLiblicensepath

public org.apache.tools.ant.types.Path createLiblicensepath()
Creates the library licenses path.

Returns:
such path.

setLiblicensepathref

public void setLiblicensepathref(org.apache.tools.ant.types.Reference ref)
Specifies the library licenses path reference.

Parameters:
ref - such reference.

setProjectname

public void setProjectname(java.lang.String name)
Specifies the project name.

Parameters:
name - the project name.

getProjectname

public java.lang.String getProjectname()
Retrieves the project name.

Returns:
such name.

setProjectversion

public void setProjectversion(java.lang.String version)
Specifies the project version.

Parameters:
version - the project version.

getProjectversion

public java.lang.String getProjectversion()
Retrieves the project version.

Returns:
such version.

setDestinationfolder

public void setDestinationfolder(java.io.File destination)
Specifies the destination folder.

Parameters:
destination - the base folder of the files to generate.

getDestinationfolder

public java.io.File getDestinationfolder()
Retrieves the destination folder.

Returns:
such folder.

setReadmefile

public void setReadmefile(java.io.File readme)
Specifies the README file.

Parameters:
readme - such file.

getReadmefile

public java.io.File getReadmefile()
Retrieves the README file.

Returns:
such file.

setAuthorsfile

public void setAuthorsfile(java.io.File authors)
Specifies the AUTHORS file.

Parameters:
authors - such file.

getAuthorsfile

public java.io.File getAuthorsfile()
Retrieves the AUTHORS file.

Returns:
such file.

setCopyingfile

public void setCopyingfile(java.io.File copying)
Specifies the COPYING file.

Parameters:
copying - such file.

getCopyingfile

public java.io.File getCopyingfile()
Retrieves the COPYING file.

Returns:
such file.

validateParameters

protected void validateParameters()
                           throws org.apache.tools.ant.BuildException
Validates the parameters given.

Throws:
org.apache.tools.ant.BuildException - if any parameter is not valid.

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Requests the AntMake generation process to be performed.

Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException - whenever the required parameters are not present or valid.


Copyright © 2004 ACM S.L.. All Rights Reserved.