Java Doc for ScriptRunnerBase.java in  » Build » ANT » org » apache » tools » ant » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.tools.ant.util.ScriptRunnerBase

All known Subclasses:   org.apache.tools.ant.util.optional.ScriptRunner,  org.apache.tools.ant.util.optional.JavaxScriptRunner,
ScriptRunnerBase
abstract public class ScriptRunnerBase (Code)
This is a common abstract base case for script runners. These classes need to implement executeScript, evaluateScript and supportsLanguage.
since:
   Ant 1.7.0




Method Summary
public  voidaddBean(String key, Object bean)
     Add a single object into the script context.
public  voidaddBeans(Map dictionary)
    
public  voidaddText(String text)
     Set the script text.
public  voidbindToComponent(ProjectComponent component)
     Bind the runner to a project component.
public  voidbindToComponentMinimum(ProjectComponent component)
     Bind the runner to a project component.
protected  voidcheckLanguage()
     Check if the language attribute is set.
public  voidclearScript()
     Clear the current script text content.
abstract public  ObjectevaluateScript(String execName)
     Evalulate the script.
Parameters:
  execName - the name that will be passed to BSF for this scriptexecution.
abstract public  voidexecuteScript(String execName)
     Do the work.
protected  MapgetBeans()
     Get the beans used for the script.
public  booleangetKeepEngine()
     Get the keep engine attribute.
public  StringgetLanguage()
    
abstract public  StringgetManagerName()
     Get the name of the manager prefix used for this scriptrunner.
public  ProjectgetProject()
     Get the project for this runner.
public  StringgetScript()
     Get the current script text content.
protected  ClassLoadergetScriptClassLoader()
     Get the classloader used to load the script engine.
protected  ClassLoaderreplaceContextLoader()
     Replace the current context classloader with the script context classloader.
protected  voidrestoreContextLoader(ClassLoader origLoader)
     Restore the context loader with the original context classloader.
public  voidsetKeepEngine(boolean keepEngine)
     Whether to keep the script engine between calls.
public  voidsetLanguage(String language)
     Defines the language (required).
public  voidsetProject(Project project)
     Set the project for this runner.
public  voidsetScriptClassLoader(ClassLoader classLoader)
     Set the script classloader.
public  voidsetSrc(File file)
     Load the script from an external file; optional.
abstract public  booleansupportsLanguage()
     Check if a script engine can be created for this language.



Method Detail
addBean
public void addBean(String key, Object bean)(Code)
Add a single object into the script context.
Parameters:
  key - the name in the context this object is to stored under.
Parameters:
  bean - the object to be stored in the script context.



addBeans
public void addBeans(Map dictionary)(Code)
Add a list of named objects to the list to be exported to the script
Parameters:
  dictionary - a map of objects to be placed into the script contextindexed by String names.



addText
public void addText(String text)(Code)
Set the script text.
Parameters:
  text - a component of the script text to be added.



bindToComponent
public void bindToComponent(ProjectComponent component)(Code)
Bind the runner to a project component. Properties, targets and references are all added as beans; project is bound to project, and self to the component.
Parameters:
  component - to become self



bindToComponentMinimum
public void bindToComponentMinimum(ProjectComponent component)(Code)
Bind the runner to a project component. The project and self are the only beans set.
Parameters:
  component - to become self



checkLanguage
protected void checkLanguage()(Code)
Check if the language attribute is set.
throws:
  BuildException - if it is not.



clearScript
public void clearScript()(Code)
Clear the current script text content.



evaluateScript
abstract public Object evaluateScript(String execName)(Code)
Evalulate the script.
Parameters:
  execName - the name that will be passed to BSF for this scriptexecution. the result of evalulating the script.



executeScript
abstract public void executeScript(String execName)(Code)
Do the work.
Parameters:
  execName - the name that will be passed to BSF for this scriptexecution.



getBeans
protected Map getBeans()(Code)
Get the beans used for the script. the map of beans.



getKeepEngine
public boolean getKeepEngine()(Code)
Get the keep engine attribute. the attribute.



getLanguage
public String getLanguage()(Code)
Get the script language the script language



getManagerName
abstract public String getManagerName()(Code)
Get the name of the manager prefix used for this scriptrunner. the prefix string.



getProject
public Project getProject()(Code)
Get the project for this runner. the project.



getScript
public String getScript()(Code)
Get the current script text content. the script text.



getScriptClassLoader
protected ClassLoader getScriptClassLoader()(Code)
Get the classloader used to load the script engine. the classloader.



replaceContextLoader
protected ClassLoader replaceContextLoader()(Code)
Replace the current context classloader with the script context classloader. the current context classloader.



restoreContextLoader
protected void restoreContextLoader(ClassLoader origLoader)(Code)
Restore the context loader with the original context classloader. script context loader.
Parameters:
  origLoader - the original context classloader.



setKeepEngine
public void setKeepEngine(boolean keepEngine)(Code)
Whether to keep the script engine between calls.
Parameters:
  keepEngine - if true, keep the engine.



setLanguage
public void setLanguage(String language)(Code)
Defines the language (required).
Parameters:
  language - the scripting language name for the script.



setProject
public void setProject(Project project)(Code)
Set the project for this runner.
Parameters:
  project - the project.



setScriptClassLoader
public void setScriptClassLoader(ClassLoader classLoader)(Code)
Set the script classloader.
Parameters:
  classLoader - the classloader to use.



setSrc
public void setSrc(File file)(Code)
Load the script from an external file; optional.
Parameters:
  file - the file containing the script source.



supportsLanguage
abstract public boolean supportsLanguage()(Code)
Check if a script engine can be created for this language. true if a script engine can be created, falseotherwise.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.