Java Doc for ResourceTool.java in  » Template-Engine » Velocity » org » apache » velocity » tools » generic » 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 » Velocity » org.apache.velocity.tools.generic 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.velocity.tools.generic.ResourceTool

All known Subclasses:   org.apache.velocity.tools.view.tools.ViewResourceTool,
ResourceTool
public class ResourceTool (Code)

Tool for accessing ResourceBundles and formatting messages therein.

 Template example(s):
 $text.foo                      ->  bar
 $text.hello.world              ->  Hello World!
 #set( $otherText = $text.bundle('otherBundle') )
 $otherText.foo                 ->  woogie
 $otherText.bar                 ->  The args are {0} and {1}.
 $otherText.bar.insert(4)       ->  The args are 4 and {1}.
 $otherText.bar.insert(4,true)  ->  The args are 4 and true.
 Toolbox configuration example:
 <tool>
 <key>text</key>
 <class>org.apache.velocity.tools.generic.ResourceTool</class>
 <parameter name="bundles" value="resources,com.foo.moreResources"/>
 <parameter name="locale" value="en_US"/>
 </tool>
 

This comes in very handy when internationalizing templates. Note that the default resource bundle baseName is "resources", and the default locale is the system locale. These may both be overridden in your toolbox config as demonstrated above.

Also, be aware that very few performance considerations have been made in this initial version. It should do fine, but if you have performance issues, please report them to dev@velocity.apache.org, so we can make improvements.


author:
   Nathan Bubna
version:
   $Revision: 498714 $ $Date: 2006-11-27 10:49:37 -0800 (Mon, 27 Nov 2006) $
since:
   VelocityTools 1.3

Inner Class :final public class Key

Field Summary
final public static  StringBUNDLES_KEY
    
final public static  StringLOCALE_KEY
    


Method Summary
public  Keybundle(String bundle)
    
public  voidconfigure(Map params)
    
public  Keyget(String key)
    
public  Objectget(String key, String baseName, Locale locale)
     Returns the value for the specified key in the ResourceBundle for the specified basename and locale.
public  Objectget(String key, String[] bundles, Locale locale)
     Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found.
final protected  StringgetDefaultBundle()
    
final protected  LocalegetDefaultLocale()
    
public  Keyinsert(Object[] args)
    
public  Keyinsert(List args)
    
public  Keyinsert(Object arg)
    
public  Keyinsert(Object arg0, Object arg1)
    
public  Keylocale(Locale locale)
    
public  Stringrender(Object resource, Object[] args)
     Renders the specified resource value and arguments as a String. If there are no arguments, then the String value of the resource is returned directly.
final protected  voidsetDefaultBundle(String bundle)
    
final protected  voidsetDefaultLocale(Locale locale)
    

Field Detail
BUNDLES_KEY
final public static String BUNDLES_KEY(Code)



LOCALE_KEY
final public static String LOCALE_KEY(Code)





Method Detail
bundle
public Key bundle(String bundle)(Code)



configure
public void configure(Map params)(Code)



get
public Key get(String key)(Code)



get
public Object get(String key, String baseName, Locale locale)(Code)
Returns the value for the specified key in the ResourceBundle for the specified basename and locale. If no such resource can be found, no errors are thrown and null is returned.



get
public Object get(String key, String[] bundles, Locale locale)(Code)
Retrieve a resource for the specified key from the first of the specified bundles in which a matching resource is found. If no resource is found, no exception will be thrown and null will be returned.



getDefaultBundle
final protected String getDefaultBundle()(Code)



getDefaultLocale
final protected Locale getDefaultLocale()(Code)



insert
public Key insert(Object[] args)(Code)



insert
public Key insert(List args)(Code)



insert
public Key insert(Object arg)(Code)



insert
public Key insert(Object arg0, Object arg1)(Code)



locale
public Key locale(Locale locale)(Code)



render
public String render(Object resource, Object[] args)(Code)
Renders the specified resource value and arguments as a String. If there are no arguments, then the String value of the resource is returned directly. If there are arguments, then the resource is treated as a MessageFormat pattern and used to format the specified argument values.



setDefaultBundle
final protected void setDefaultBundle(String bundle)(Code)



setDefaultLocale
final protected void setDefaultLocale(Locale locale)(Code)



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.