Package pyb :: Package tasks :: Module java
[show private | hide private]
[frames | no frames]

Module pyb.tasks.java

Tasks related to Java.

Copyright (C) 2004 Aetrion LLC

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
Function Summary
  ear(basedir, destfile, compress, appxml, includeFilters, excludeFilters)
Create an EAR archive.
  jar(basedir, destfile, compress, index, manifest, includeFilters, excludeFilters, extraArgs)
Execute the jar application.
  java(mainclass, classpath)
Execute the java application.
  javac(basedir, destdir, deprecation, debug, verbose, optimize, classpath, target, includeFilters, excludeFilters, extraArgs)
Execute the javac application.
  javadoc(basedir, destdir, classpath, packagenames, author, version, windowtitle, doctitle, header, footer, bottom, overview, extraArgs, printstdout, printstderror)
Execute the javadocs application.
  unjar(src, destdir)
Unzip the specified jar file into the given directory.
  unwar(src, destdir)
Unzip the specified war file into the given directory.
  war(basedir, destfile, compress, webxml, includeFilters, excludeFilters)
Create a WAR archive.
  __getJavaCommand(commandName)
Construct the full path to a java executable command using the JAVA_HOME environment variable.

Function Details

ear(basedir='', destfile=None, compress=True, appxml=None, includeFilters=['.*'], excludeFilters=[])

Create an EAR archive.
Parameters:
basedir - The base directory (current directory)
destfile - The file to write to (REQUIRED)
appxml - The application.xml file (None)
includeFilters - Regular expression strings to include files (All files)
excludeFilters - Regular expression strings to exclude files (empty list)

jar(basedir='', destfile=None, compress=True, index=False, manifest=None, includeFilters=['.*\\.class'], excludeFilters=[], extraArgs=[])

Execute the jar application.
Parameters:
basedir - The base directory (current directory)
destfile - The jar file (REQUIRED)
compress - Set to False to disable compression (True)
index - Set to True to index (False)
manifest - Specify a manifest file
includeFilters - Regular expression strings used to include files (Files ending with .class)
excludeFilters - Regular expression strings used to exclude files (empty list)
extraArgs - Extra command-line arguments (empty list)

java(mainclass=None, classpath=None)

Execute the java application.
Parameters:
mainclass - The main class to execute (without the .class)
classpath - User-defined classpath

javac(basedir='', destdir='', deprecation=False, debug=True, verbose=False, optimize=True, classpath=None, target=None, includeFilters=['.*\\.java'], excludeFilters=['.*#.*', '.*CVS\\.*'], extraArgs=[])

Execute the javac application.
Parameters:
basedir - The base directory (current directory)
destdir - The destination directory (current directory)
deprecation - Set to True to enable deprecation warnings (False)
debug - Set to False to disable debug data in classfiles (True)
verbose - Set to True for verbose compiler messages (False)
optimize - Set to False to disable optimize when compiling (True)
classpath - Specify a custom classpath (None)
target - Specify a target JVM version (None)
includeFilters - Regular expression strings used to include files (All .java files)
           (type=list of strings)
excludeFilters - Regular expression strings used to exclude files
           (type=list of strings)
extraArgs - Extra command-line arguments (empty list)
           (type=list of strings)

javadoc(basedir='', destdir='', classpath=None, packagenames=[], author=False, version=None, windowtitle=None, doctitle=None, header=None, footer=None, bottom=None, overview=None, extraArgs=[], printstdout=False, printstderror=False)

Execute the javadocs application.
Parameters:
basedir - The base directory to find source, i.e. the sourcepath argument in the javadoc tool (current directory)
destdir - The destination directory (current directory)
classpath - Specify a custom classpath (None)
           (type=List of directories and JARs)
packagenames - List of package names. Packages are searched recursively.
author - Set to True to include author in JavaDoc (False)
           (type=boolean)
version - Set to True to include version in JavaDoc (False)
windowtitle - Set the window title string (empty string)
doctitle - Set the document title string (empty string)
header - Path to the header file
footer - Path to the footer file
bottom - Bottom text
overview - Path to the overview file
extraArgs - Extra command-line arguments (empty list)
           (type=list of strings)
printstdout - Set to True to print all javadoc application output
printstderror - Set to True to print all javadoc stderror output

unjar(src, destdir)

Unzip the specified jar file into the given directory.
Parameters:
src - The source jar file
destdir - The destination directory

unwar(src, destdir)

Unzip the specified war file into the given directory.
Parameters:
src - The source war file
destdir - The destination directory

war(basedir='', destfile=None, compress=True, webxml=None, includeFilters=['.*'], excludeFilters=[])

Create a WAR archive.
Parameters:
basedir - The base directory (current directory)
destfile - The ZIP file to write to (REQUIRED)
webxml - The web.xml file (None)
includeFilters - Regular expression strings to include files (All files)
excludeFilters - Regular expression strings to exclude files (empty list)

__getJavaCommand(commandName)

Construct the full path to a java executable command using the JAVA_HOME environment variable. If the JAVA_HOME environment variable is not set then the application prints an error and exits.
Parameters:
commandName - The command name
Returns:
The path to a binary

Generated by Epydoc 2.1 on Fri Apr 23 15:39:19 2004 http://epydoc.sf.net