Java Doc for Substitution.java in  » Template-Engine » Tea » com » go » tea » runtime » 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 » Template Engine » Tea » com.go.tea.runtime 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.go.tea.runtime.Substitution

Substitution
public interface Substitution (Code)
A block of code in a template that can be passed as a substitution to another template or to a function, must implement this interface. A function that defines its last parameter as a Substitution can receive a block of code from a template. To execute it, call substitute.

Substitution blocks can contain internal state information which may change when the called function returns. Therefore, Substitution objects should never be saved unless explicitly detached.

Functions that accept a Substitution appear to extend the template language itself. Condsider the following example, which implements a simple looping function:

 public void loop(int count, Substitution s) throws Exception {
 while (--count >= 0) {
 s.substitute();
 }
 }
 
The template might invoke this function as:
 loop (100) {
 "This message is printed 100 times\n"
 }
 

author:
   Brian S O'Neill
version:
   15 , 01/05/03




Method Summary
public  Substitutiondetach()
     Returns a detached substitution that can be saved and re-used.
public  ObjectgetIdentifier()
     Returns an object that uniquely identifies this substitution block.
public  voidsubstitute()
     Causes the code substitution block to execute against its current output receiver.
public  voidsubstitute(Context context)
     Causes the code substitution block to execute against any context.



Method Detail
detach
public Substitution detach()(Code)
Returns a detached substitution that can be saved and re-used. Detaching a substitution provides greater flexibilty when implementing template output caching strategies. One thread may execute the substitution while another thread may, upon timing out, output the previously cached output from this substitution.

When calling substitute, a context must be provided or else an UnsupportedOperationException is thrown. In order for multiple threads to safely execute this substitution, each must have its own detached instance.




getIdentifier
public Object getIdentifier()(Code)
Returns an object that uniquely identifies this substitution block.



substitute
public void substitute() throws Exception(Code)
Causes the code substitution block to execute against its current output receiver.
throws:
  UnsupportedOperationException - if this Substitution was detached.



substitute
public void substitute(Context context) throws Exception(Code)
Causes the code substitution block to execute against any context.
throws:
  ClassCastException - if context is incompatible with thissubstitution.



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