Java Doc for TransformControl.java in  » Template-Engine » freemarker-2.3.10 » freemarker » template » 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 » freemarker 2.3.10 » freemarker.template 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


freemarker.template.TransformControl

TransformControl
public interface TransformControl (Code)
An interface that can be implemented by writers returned from TemplateTransformModel.getWriter(java.io.Writerjava.util.Map) . The methods on this interfaces are callbacks that will be called by the template engine and that give the writer a chance to better control the evaluation of the transform body. The writer can instruct the engine to skip or to repeat body evaluation, and gets notified about exceptions that are thrown during the body evaluation.
author:
   Attila Szegedi
version:
   $Id: TransformControl.java,v 1.11 2005/06/16 18:13:58 ddekany Exp $


Field Summary
final public static  intEND_EVALUATION
     Constant returned from TransformControl.afterBody() that tells the template engine to end the transform and close the writer.
final public static  intEVALUATE_BODY
     Constant returned from TransformControl.onStart() that tells the template engine to evaluate the body.
final public static  intREPEAT_EVALUATION
     Constant returned from TransformControl.afterBody() that tells the template engine to repeat transform body evaluation and feed it again to the transform.
final public static  intSKIP_BODY
     Constant returned from TransformControl.onStart() that tells the template engine to skip evaluation of the body.


Method Summary
public  intafterBody()
     Called after the body has been evaluated.
public  voidonError(Throwable t)
     Called if any exception occurs during the transform between the TemplateTransformModel.getWriter(java.io.Writerjava.util.Map) call and the java.io.Writer.close call.
Parameters:
  t - the throwable that represents the exception.
public  intonStart()
     Called before the body is evaluated for the first time.
  • SKIP_BODY if the transform wants to ignore the body.

Field Detail
END_EVALUATION
final public static int END_EVALUATION(Code)
Constant returned from TransformControl.afterBody() that tells the template engine to end the transform and close the writer.



EVALUATE_BODY
final public static int EVALUATE_BODY(Code)
Constant returned from TransformControl.onStart() that tells the template engine to evaluate the body.



REPEAT_EVALUATION
final public static int REPEAT_EVALUATION(Code)
Constant returned from TransformControl.afterBody() that tells the template engine to repeat transform body evaluation and feed it again to the transform.



SKIP_BODY
final public static int SKIP_BODY(Code)
Constant returned from TransformControl.onStart() that tells the template engine to skip evaluation of the body.





Method Detail
afterBody
public int afterBody() throws TemplateModelException, IOException(Code)
Called after the body has been evaluated.
  • END_EVALUATION if the transformation should be ended.
  • REPEAT_EVALUATION to have the engine re-evaluate the transform body and feed it again to the writer.



onError
public void onError(Throwable t) throws Throwable(Code)
Called if any exception occurs during the transform between the TemplateTransformModel.getWriter(java.io.Writerjava.util.Map) call and the java.io.Writer.close call.
Parameters:
  t - the throwable that represents the exception. It can be any non-checked throwable, as well as TemplateException and java.io.IOException.
throws:
  Throwable - is recommended that the methods rethrow the received throwable. If the method wants to throw another throwable, it shouldeither throw a non-checked throwable, or an instance of TemplateException and java.io.IOException. Throwing anyother checked exception will cause the engine to rethrow it asa java.lang.reflect.UndeclaredThrowableException.



onStart
public int onStart() throws TemplateModelException, IOException(Code)
Called before the body is evaluated for the first time.
  • SKIP_BODY if the transform wants to ignore the body. In thiscase, only java.io.Writer.close is called next and processing ends.
  • EVALUATE_BODY to normally evaluate the body of the transformand feed it to the writer



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