com.ibm.websphere.ant.tasks
Class NLSEcho
java.lang.Object
|
+--org.apache.tools.ant.ProjectComponent
|
+--org.apache.tools.ant.Task
|
+--org.apache.tools.ant.taskdefs.Echo
|
+--com.ibm.websphere.ant.tasks.NLSEcho
- public class NLSEcho
- extends org.apache.tools.ant.taskdefs.Echo
wsNLSEcho Task: This is a echo extension task to display translated messages. Also provides
variable substitution in the message.
Attributes:
key Key to look for in resource bundle --- Not required
bundle Resource bundle from where resource for key to be loaded - Not required
message Default message - Required
replace substitution arguments seperated by ";;" - Not required
Usage:
Examples:
Above will echo the message using resource bundle "installapps" with key ISUCCESS. If ISUCCESS is
not present in resource bundlle or resource bundle is missing ,default message "Installing app successful" is printed.
Variable substitution can be done using {x} similar to MessageFormat
replace takes parameter values seperated by ;;. In the above example {0} is replaced with "hello" and {1} is replaced with "server1"
To use this task in your build.xml, include the following taskdef:
- Version:
- 1.0
- See Also:
Copyright IBM Corp. 2002
Source File: NLSEcho.java
Creation Date: August 13, 2002
Inner classes inherited from class org.apache.tools.ant.taskdefs.Echo |
org.apache.tools.ant.taskdefs.Echo.EchoLevel |
Field Summary |
protected java.lang.String |
bundle
|
protected java.lang.String |
key
|
protected java.lang.String[] |
tokens
|
Fields inherited from class org.apache.tools.ant.taskdefs.Echo |
append, file, logLevel, message |
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 |
Method Summary |
protected void |
doTranslation()
Get translated message |
void |
execute()
Execute the task |
protected java.lang.String |
getBundle()
Returns the fileName. |
protected java.lang.String |
getKey()
Returns the key. |
void |
setBundle(java.lang.String bundle)
Set the file name to be used as resource bundle |
void |
setKey(java.lang.String key)
key to be translated |
void |
setReplace(java.lang.String str)
Replaces {x} with values specified |
Methods inherited from class org.apache.tools.ant.taskdefs.Echo |
addText, setAppend, setFile, setLevel, setMessage |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
bundle
protected java.lang.String bundle
key
protected java.lang.String key
tokens
protected java.lang.String[] tokens
NLSEcho
public NLSEcho()
setBundle
public void setBundle(java.lang.String bundle)
- Set the file name to be used as resource bundle
execute
public void execute()
- Execute the task
- Overrides:
execute
in class org.apache.tools.ant.taskdefs.Echo
setKey
public void setKey(java.lang.String key)
- key to be translated
doTranslation
protected void doTranslation()
- Get translated message
getBundle
protected java.lang.String getBundle()
- Returns the fileName.
- Returns:
- String
getKey
protected java.lang.String getKey()
- Returns the key.
- Returns:
- String
setReplace
public void setReplace(java.lang.String str)
- Replaces {x} with values specified