Java Doc for BasePropertiesConfiguration.java in  » Forum » mvnforum-1.1 » net » myvietnam » mvncore » configuration » 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 » Forum » mvnforum 1.1 » net.myvietnam.mvncore.configuration 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.myvietnam.mvncore.configuration.AbstractConfiguration
      net.myvietnam.mvncore.configuration.BaseConfiguration
         net.myvietnam.mvncore.configuration.BasePathConfiguration
            net.myvietnam.mvncore.configuration.BasePropertiesConfiguration

All known Subclasses:   net.myvietnam.mvncore.configuration.ClassPropertiesConfiguration,  net.myvietnam.mvncore.configuration.PropertiesConfiguration,
BasePropertiesConfiguration
abstract public class BasePropertiesConfiguration extends BasePathConfiguration (Code)
loads the configuration from a properties file.

The properties file syntax is explained here:

  • Each property has the syntax key = value
  • The key may use any character but the equal sign '='.
  • value may be separated on different lines if a backslash is placed at the end of the line that continues below.
  • If value is a list of strings, each token is separated by a comma ','.
  • Commas in each token are escaped placing a backslash right before the comma.
  • If a key is used more than once, the values are appended like if they were on the same line separated with commas.
  • Blank lines and lines starting with character '#' are skipped.
  • If a property is named "include" (or whatever is defined by setInclude() and getInclude() and the value of that property is the full path to a file on disk, that file will be included into the ConfigurationsRepository. You can also pull in files relative to the parent configuration file. So if you have something like the following: include = additional.properties Then "additional.properties" is expected to be in the same directory as the parent configuration file. Duplicate name values will be replaced, so be careful.

Here is an example of a valid extended properties file:

 # lines starting with # are comments
 # This is the simplest property
 key = value
 # A long property may be separated on multiple lines
 longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 # This is a property with many tokens
 tokens_on_a_line = first token, second token
 # This sequence generates exactly the same result
 tokens_on_multiple_lines = first token
 tokens_on_multiple_lines = second token
 # commas may be escaped in tokens
 commas.excaped = Hi\, what'up?
 # properties can reference other properties
 base.prop = /base
 first.prop = ${base.prop}/first
 second.prop = ${first.prop}/second
 

author:
   Stefano Mazzocchi
author:
   Jon S. Stevens
author:
   Dave Bryson
author:
   Geir Magnusson Jr.
author:
   Leon Messerschmidt
author:
   Kent Johnson
author:
   Daniel Rall
author:
   Ilkka Priha
author:
   Jason van Zyl
author:
   Martin Poeschl
author:
   Henning P. Schmiedehausen
version:
   $Id: BasePropertiesConfiguration.java,v 1.2 2003/12/10 04:30:45 minhnn Exp $

Inner Class :class PropertiesReader extends LineNumberReader
Inner Class :class PropertiesWriter extends FileWriter

Field Summary
protected static  Stringinclude
     This is the name of the property that can point to other properties file for including other properties files.


Method Summary
public  StringgetInclude()
     Gets the property value for including other properties files.
public  booleangetIncludesAllowed()
     Reports the status of file inclusion.
abstract protected  InputStreamgetPropertyStream(String resourceName)
     Implementations of this class must implement this method.
public  voidload(InputStream input)
     Load the properties from the given input stream.
public synchronized  voidload(InputStream input, String enc)
     Load the properties from the given input stream and using the specified encoding.
public  voidsave(String filename)
     save properties to a file.
public  voidsetInclude(String inc)
     Sets the property value for including other properties files.
protected  voidsetIncludesAllowed(boolean includesAllowed)
     Controls whether additional files can be loaded by the include = statement or not.

Field Detail
include
protected static String include(Code)
This is the name of the property that can point to other properties file for including other properties files.





Method Detail
getInclude
public String getInclude()(Code)
Gets the property value for including other properties files. By default it is "include". A String.



getIncludesAllowed
public boolean getIncludesAllowed()(Code)
Reports the status of file inclusion. True if include files are loaded.



getPropertyStream
abstract protected InputStream getPropertyStream(String resourceName) throws IOException(Code)
Implementations of this class must implement this method.
Parameters:
  resourceName - The Resource to load An Input Stream
throws:
  IOException - Error while loading the properties file



load
public void load(InputStream input) throws IOException(Code)
Load the properties from the given input stream.
Parameters:
  input - An InputStream.
throws:
  IOException -



load
public synchronized void load(InputStream input, String enc) throws IOException(Code)
Load the properties from the given input stream and using the specified encoding.
Parameters:
  input - An InputStream.
Parameters:
  enc - An encoding.
exception:
  IOException -



save
public void save(String filename) throws IOException(Code)
save properties to a file. properties with multiple values are saved comma seperated.
Parameters:
  filename - name of the properties file
throws:
  IOException -



setInclude
public void setInclude(String inc)(Code)
Sets the property value for including other properties files. By default it is "include".
Parameters:
  inc - A String.



setIncludesAllowed
protected void setIncludesAllowed(boolean includesAllowed)(Code)
Controls whether additional files can be loaded by the include = statement or not. Base rule is, that objects created by the empty C'tor can not have included files.
Parameters:
  includesAllowed - includesAllowed True if Includes are allowed.



Methods inherited from net.myvietnam.mvncore.configuration.BasePathConfiguration
public String getBasePath()(Code)(Java Doc)
public void setBasePath(String basePath)(Code)(Java Doc)

Methods inherited from net.myvietnam.mvncore.configuration.BaseConfiguration
protected void addPropertyDirect(String key, Object obj)(Code)(Java Doc)
public void clearProperty(String key)(Code)(Java Doc)
public boolean containsKey(String key)(Code)(Java Doc)
public Iterator getKeys()(Code)(Java Doc)
protected Object getPropertyDirect(String key)(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)

Fields inherited from net.myvietnam.mvncore.configuration.AbstractConfiguration
final protected static String END_TOKEN(Code)(Java Doc)
final protected static String START_TOKEN(Code)(Java Doc)
protected Configuration defaults(Code)(Java Doc)

Methods inherited from net.myvietnam.mvncore.configuration.AbstractConfiguration
public void addProperty(String key, Object token)(Code)(Java Doc)
abstract protected void addPropertyDirect(String key, Object obj)(Code)(Java Doc)
abstract public void clearProperty(String key)(Code)(Java Doc)
abstract public boolean containsKey(String key)(Code)(Java Doc)
public boolean getBoolean(String key)(Code)(Java Doc)
public boolean getBoolean(String key, boolean defaultValue)(Code)(Java Doc)
public Boolean getBoolean(String key, Boolean defaultValue)(Code)(Java Doc)
public byte getByte(String key)(Code)(Java Doc)
public byte getByte(String key, byte defaultValue)(Code)(Java Doc)
public Byte getByte(String key, Byte defaultValue)(Code)(Java Doc)
public double getDouble(String key)(Code)(Java Doc)
public double getDouble(String key, double defaultValue)(Code)(Java Doc)
public Double getDouble(String key, Double defaultValue)(Code)(Java Doc)
public float getFloat(String key)(Code)(Java Doc)
public float getFloat(String key, float defaultValue)(Code)(Java Doc)
public Float getFloat(String key, Float defaultValue)(Code)(Java Doc)
public int getInt(String key)(Code)(Java Doc)
public int getInt(String key, int defaultValue)(Code)(Java Doc)
public Integer getInteger(String key, Integer defaultValue)(Code)(Java Doc)
abstract public Iterator getKeys()(Code)(Java Doc)
public Iterator getKeys(String prefix)(Code)(Java Doc)
public long getLong(String key)(Code)(Java Doc)
public long getLong(String key, long defaultValue)(Code)(Java Doc)
public Long getLong(String key, Long defaultValue)(Code)(Java Doc)
public Properties getProperties(String key)(Code)(Java Doc)
public Properties getProperties(String key, Properties defaults)(Code)(Java Doc)
public Object getProperty(String key)(Code)(Java Doc)
abstract protected Object getPropertyDirect(String key)(Code)(Java Doc)
public short getShort(String key)(Code)(Java Doc)
public short getShort(String key, short defaultValue)(Code)(Java Doc)
public Short getShort(String key, Short defaultValue)(Code)(Java Doc)
public String getString(String key)(Code)(Java Doc)
public String getString(String key, String defaultValue)(Code)(Java Doc)
public String[] getStringArray(String key)(Code)(Java Doc)
public Vector getVector(String key)(Code)(Java Doc)
public Vector getVector(String key, Vector defaultValue)(Code)(Java Doc)
protected String interpolate(String base)(Code)(Java Doc)
protected String interpolateHelper(String base, List priorVariables)(Code)(Java Doc)
abstract public boolean isEmpty()(Code)(Java Doc)
protected List processString(String token)(Code)(Java Doc)
public void setProperty(String key, Object value)(Code)(Java Doc)
public Configuration subset(String prefix)(Code)(Java Doc)
final protected Boolean testBoolean(String value)(Code)(Java Doc)

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.