org.objectweb.jonas.ant.jonasbase.JTask Class Reference

Inherits org.objectweb.jonas.ant.BootstrapTask, and org.objectweb.jonas.ant.jonasbase.BaseTaskItf.

Inherited by org.objectweb.jonas.ant.jonasbase.Db, org.objectweb.jonas.ant.jonasbase.Dbm, org.objectweb.jonas.ant.jonasbase.JdbcRa, org.objectweb.jonas.ant.jonasbase.Mail, org.objectweb.jonas.ant.jonasbase.Services, and org.objectweb.jonas.ant.jonasbase.WsdlPublish.

Inheritance diagram for org.objectweb.jonas.ant.jonasbase.JTask:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.jonas.ant.jonasbase.JTask:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void setConfigurationFile (String configurationFile)
void setDestDir (File destDir)
String getLogInfo ()
void setLogInfo (String logInfo)
File getDestDir ()

Static Public Attributes

final String SEPARATORS = " "

Protected Member Functions

void writePropsToFile (String info, Properties props, File f)
void changeValueForKey (String info, String confDir, String confFile, String property, String name, boolean add)
void changeValueForKey (String info, String confDir, String confFile, String property, String name, String separators, boolean add)
String getConfigurationFile ()

Detailed Description

Defines a common task
Author:
Florent Benoit

Definition at line 44 of file JTask.java.


Member Function Documentation

void org.objectweb.jonas.ant.jonasbase.JTask.changeValueForKey String  info,
String  confDir,
String  confFile,
String  property,
String  name,
String  separators,
boolean  add
[protected]
 

Add a value for a specific property in a configuration file

Parameters:
info text to be displayed for header
confDir configuration directory (can be JONAS_BASE/conf)
confFile configuration file (can be jonas.properties)
property which must be found in confFile
name value for the property to add
separators separator using between the property name and the property value
add if true, add it, else replace

Definition at line 157 of file JTask.java.

References org.objectweb.jonas.ant.jonasbase.BaseTaskItf.execute(), org.objectweb.jonas.ant.jonasbase.JTask.getDestDir(), org.objectweb.jonas.ant.jonasbase.JReplace.setConfigurationFile(), and org.objectweb.jonas.ant.jonasbase.JReplace.setDestDir().

Here is the call graph for this function:

void org.objectweb.jonas.ant.jonasbase.JTask.changeValueForKey String  info,
String  confDir,
String  confFile,
String  property,
String  name,
boolean  add
[protected]
 

Add a value for a specific property in a configuration file. The separator uses between the property name and the property value is the default separator value.

Parameters:
info text to be displayed for header
confDir configuration directory (can be JONAS_BASE/conf)
confFile configuration file (can be jonas.properties)
property which must be found in confFile
name value for the property to add
add if true, add it, else replace

Definition at line 143 of file JTask.java.

References org.objectweb.jonas.ant.jonasbase.JTask.SEPARATORS.

Referenced by org.objectweb.jonas.ant.jonasbase.Services.execute(), org.objectweb.jonas.ant.jonasbase.Mail.execute(), org.objectweb.jonas.ant.jonasbase.JdbcRa.execute(), org.objectweb.jonas.ant.jonasbase.Dbm.execute(), and org.objectweb.jonas.ant.jonasbase.Db.execute().

String org.objectweb.jonas.ant.jonasbase.JTask.getConfigurationFile  )  [protected]
 

Returns:
the configurationFile.

Definition at line 202 of file JTask.java.

File org.objectweb.jonas.ant.jonasbase.JTask.getDestDir  ) 
 

Gets the destination directory

Returns:
the destination directory

Definition at line 103 of file JTask.java.

Referenced by org.objectweb.jonas.ant.jonasbase.JTask.changeValueForKey(), org.objectweb.jonas.ant.jonasbase.WsdlPublish.execute(), org.objectweb.jonas.ant.jonasbase.Services.execute(), org.objectweb.jonas.ant.jonasbase.Mail.execute(), org.objectweb.jonas.ant.jonasbase.JdbcRa.execute(), org.objectweb.jonas.ant.jonasbase.Dbm.execute(), and org.objectweb.jonas.ant.jonasbase.Db.execute().

String org.objectweb.jonas.ant.jonasbase.JTask.getLogInfo  ) 
 

Gets logger info (to be displayed)

Returns:
logger info
See also:
org.objectweb.jonas.ant.jonasbase.BaseTaskItf.getLogInfo()

Implements org.objectweb.jonas.ant.jonasbase.BaseTaskItf.

Definition at line 86 of file JTask.java.

void org.objectweb.jonas.ant.jonasbase.JTask.setConfigurationFile String  configurationFile  ) 
 

Sets the configuration file

Parameters:
configurationFile The configurationFile to set.

Implements org.objectweb.jonas.ant.jonasbase.BaseTaskItf.

Definition at line 70 of file JTask.java.

void org.objectweb.jonas.ant.jonasbase.JTask.setDestDir File  destDir  ) 
 

Parameters:
destDir The destDir to set.

Implements org.objectweb.jonas.ant.jonasbase.BaseTaskItf.

Definition at line 77 of file JTask.java.

void org.objectweb.jonas.ant.jonasbase.JTask.setLogInfo String  logInfo  ) 
 

Set the info to be displayed by the logger

Parameters:
logInfo information to be displayed
See also:
org.objectweb.jonas.ant.jonasbase.BaseTaskItf.setLogInfo(java.lang.String)

Implements org.objectweb.jonas.ant.jonasbase.BaseTaskItf.

Definition at line 95 of file JTask.java.

void org.objectweb.jonas.ant.jonasbase.JTask.writePropsToFile String  info,
Properties  props,
File  f
[protected]
 

Write properties object to a file with some logging info

Parameters:
info header for logging
props Properties to write
f file for writing

Definition at line 113 of file JTask.java.

Referenced by org.objectweb.jonas.ant.jonasbase.WsdlPublish.execute(), org.objectweb.jonas.ant.jonasbase.Mail.execute(), and org.objectweb.jonas.ant.jonasbase.JdbcRa.execute().


Member Data Documentation

final String org.objectweb.jonas.ant.jonasbase.JTask.SEPARATORS = " " [static]
 

Property separators (4 spaces)

Definition at line 49 of file JTask.java.

Referenced by org.objectweb.jonas.ant.jonasbase.JTask.changeValueForKey().


The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:06:22 2005 for JOnAS by  doxygen 1.3.9.1