Java Doc for PropertiesSubstitutor.java in  » Scripting » scriptella » scriptella » expression » 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 » Scripting » scriptella » scriptella.expression 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   scriptella.expression.PropertiesSubstitutor

PropertiesSubstitutor
public class PropertiesSubstitutor (Code)
Substitutes properties(or expressions) in strings.

$ symbol indicate property or expression to evaluate and substitute.

The following properties/expression syntax is used:

Property reference

References named property.
Examples:

 $foo
 

Expression

. Expression is wrapped by braces and evaluated by Expression engine. Examples:

 ${name+' '+surname} etc.
 

This class is not thread safe
author:
   Fyodor Kupolov
version:
   1.0



Field Summary
final public static  PatternEXPR_PTR
     Expression pattern, e.g.
final public static  PatternPROP_PTR
     Simple property patterns, e.g.
final  Matcherm1
    
final  Matcherm2
    

Constructor Summary
public  PropertiesSubstitutor()
     Creates a properties substitutor.
public  PropertiesSubstitutor(ParametersCallback parameters)
     Creates a properties substitutor.
public  PropertiesSubstitutor(Map<String, ?> map)
     Creates a properties substitutor based on specified properties map.

Method Summary
static  intfirstCandidate(String string)
    
public  ParametersCallbackgetParameters()
    
public static  booleanhasProperties(String string)
     Tests if the given string contains properties/expressions.
Parameters:
  string - string to check.
public  voidsetParameters(ParametersCallback parameters)
     Sets parameters callback used for substitution.
public  Stringsubstitute(String s)
     Substitutes properties/expressions in s and returns the result string.

If result of evaluation is null or the property being substitued doesn't have value in callback - the whole expressions is copied into result string as is.
Parameters:
  s - string to substitute.

public  voidsubstitute(Reader reader, Writer writer)
     Copies content from reader to writer and expands properties.
public  Stringsubstitute(Reader reader)
     Reads content from reader and expands properties.

Note: For performance reasons use PropertiesSubstitutor.substitute(java.io.Reader,java.io.Writer) if possible.
Parameters:
  reader - reader to process.

protected  StringtoString(Object o)
     Converts specified object to string.

Subclasses may provide custom conversion strategy here.
Parameters:
  o - object to convert to String.


Field Detail
EXPR_PTR
final public static Pattern EXPR_PTR(Code)
Expression pattern, e.g. ${property} etc.



PROP_PTR
final public static Pattern PROP_PTR(Code)
Simple property patterns, e.g. $property



m1
final Matcher m1(Code)



m2
final Matcher m2(Code)




Constructor Detail
PropertiesSubstitutor
public PropertiesSubstitutor()(Code)
Creates a properties substitutor.

This constructor is used for performance critical places where multiple instantiation via PropertiesSubstitutor.PropertiesSubstitutor(scriptella.spi.ParametersCallback) is expensive.

Note: PropertiesSubstitutor.setParameters(scriptella.spi.ParametersCallback) must be called before PropertiesSubstitutor.substitute(String) .




PropertiesSubstitutor
public PropertiesSubstitutor(ParametersCallback parameters)(Code)
Creates a properties substitutor.
Parameters:
  parameters - parameters callback to use for substitution.



PropertiesSubstitutor
public PropertiesSubstitutor(Map<String, ?> map)(Code)
Creates a properties substitutor based on specified properties map.
Parameters:
  map - parameters to substitute.




Method Detail
firstCandidate
static int firstCandidate(String string)(Code)



getParameters
public ParametersCallback getParameters()(Code)
parameter callback used for substitution.



hasProperties
public static boolean hasProperties(String string)(Code)
Tests if the given string contains properties/expressions.
Parameters:
  string - string to check. true if a given string contains properties/expressions.



setParameters
public void setParameters(ParametersCallback parameters)(Code)
Sets parameters callback used for substitution.
Parameters:
  parameters - not null parameters callback.



substitute
public String substitute(String s)(Code)
Substitutes properties/expressions in s and returns the result string.

If result of evaluation is null or the property being substitued doesn't have value in callback - the whole expressions is copied into result string as is.
Parameters:
  s - string to substitute. Null strings allowed. substituted string.




substitute
public void substitute(Reader reader, Writer writer) throws IOException(Code)
Copies content from reader to writer and expands properties.
Parameters:
  reader - reader to process.
Parameters:
  writer - writer to output substituted content to.
throws:
  IOException - if I/O error occurs.



substitute
public String substitute(Reader reader) throws IOException(Code)
Reads content from reader and expands properties.

Note: For performance reasons use PropertiesSubstitutor.substitute(java.io.Reader,java.io.Writer) if possible.
Parameters:
  reader - reader to process. reader's content with properties expanded.
throws:
  IOException - if I/O error occurs.
See Also:   PropertiesSubstitutor.substitute(java.io.Reader,java.io.Writer)




toString
protected String toString(Object o)(Code)
Converts specified object to string.

Subclasses may provide custom conversion strategy here.
Parameters:
  o - object to convert to String. string representation of object.




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.