Java Doc for Configuration.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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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)

net.myvietnam.mvncore.configuration .Configuration

All known Subclasses:   net.myvietnam.mvncore.configuration .JNDIConfiguration,  net.myvietnam.mvncore.configuration .ClassPropertiesConfiguration,  net.myvietnam.mvncore.configuration .CompositeConfiguration,  net.myvietnam.mvncore.configuration .PropertiesConfiguration,  net.myvietnam.mvncore.configuration .AbstractConfiguration,
Configuration
public interface Configuration (Code)
Configuration interface. The general idea here is to make something that will work like our extended properties and be compatible with the preferences API if at all possible.
author:
   Jason van Zyl
author:
   Martin Poeschl
version:
   $Id: Configuration.java,v 1.3 2004/06/27 01:20:38 skoehler Exp $

Method Summary
void addProperty(String key, Object value)
     Add a property to the configuration.
void clearProperty(String key)
     Clear a property in the configuration.
boolean containsKey(String key)
     Check if the configuration contains the key.
boolean getBoolean(String key)
     Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key.
boolean getBoolean(String key, boolean defaultValue)
     Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Boolean getBoolean(String key, Boolean defaultValue)
     Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
byte getByte(String key)
     Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key.
byte getByte(String key, byte defaultValue)
     Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Byte getByte(String key, Byte defaultValue)
     Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
double getDouble(String key)
     Get a double associated with the given configuration key.
Parameters:
  key - The configuration key.
double getDouble(String key, double defaultValue)
     Get a double associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Double getDouble(String key, Double defaultValue)
     Get a double associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
float getFloat(String key)
     Get a float associated with the given configuration key.
Parameters:
  key - The configuration key.
float getFloat(String key, float defaultValue)
     Get a float associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Float getFloat(String key, Float defaultValue)
     Get a float associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
int getInt(String key)
     Get a int associated with the given configuration key.
Parameters:
  key - The configuration key.
int getInt(String key, int defaultValue)
     Get a int associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Integer getInteger(String key, Integer defaultValue)
     Get a int associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Iterator getKeys(String prefix)
     Get the list of the keys contained in the configuration repository that match the specified prefix.
Parameters:
  prefix - The prefix to test against.
Iterator getKeys()
     Get the list of the keys contained in the configuration repository.
long getLong(String key)
     Get a long associated with the given configuration key.
Parameters:
  key - The configuration key.
long getLong(String key, long defaultValue)
     Get a long associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Long getLong(String key, Long defaultValue)
     Get a long associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Properties getProperties(String key)
     Get a list of properties associated with the given configuration key.
Parameters:
  key - The configuration key.
Object getProperty(String key)
     Gets a property from the configuration.
Parameters:
  key - property to retrieve value as object.
short getShort(String key)
     Get a short associated with the given configuration key.
Parameters:
  key - The configuration key.
short getShort(String key, short defaultValue)
     Get a short associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
Short getShort(String key, Short defaultValue)
     Get a short associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
String getString(String key)
     Get a string associated with the given configuration key.
Parameters:
  key - The configuration key.
String getString(String key, String defaultValue)
     Get a string associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
String[] getStringArray(String key)
     Get an array of strings associated with the given configuration key.
Parameters:
  key - The configuration key.
Vector getVector(String key)
     Get a Vector of strings associated with the given configuration key.
Parameters:
  key - The configuration key.
Vector getVector(String key, Vector defaultValue)
     Get a Vector of strings associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value.
boolean isEmpty()
     Check if the configuration is empty.
void setProperty(String key, Object value)
     Set a property, this will replace any previously set values.
Configuration subset(String prefix)
     Create an Configuration object that is a subset of this one.

Method Detail
addProperty
void addProperty(String key, Object value)(Code)
Add a property to the configuration. If it already exists then the value stated here will be added to the configuration entry. For example, if resource.loader = file is already present in the configuration and you addProperty("resource.loader", "classpath") Then you will end up with a Vector like the following: ["file", "classpath"]
Parameters:
  key - The Key to add the property to.
Parameters:
  value - The Value to add.

clearProperty
void clearProperty(String key)(Code)
Clear a property in the configuration.
Parameters:
  key - the key to remove along with corresponding value.

containsKey
boolean containsKey(String key)(Code)
Check if the configuration contains the key. true is the configuration contains a value for this key, false otherwise

getBoolean
boolean getBoolean(String key)(Code)
Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key. The associated boolean.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Boolean.

getBoolean
boolean getBoolean(String key, boolean defaultValue)(Code)
Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated boolean.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Boolean.

getBoolean
Boolean getBoolean(String key, Boolean defaultValue)(Code)
Get a boolean associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated boolean if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Boolean.

getByte
byte getByte(String key)(Code)
Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key. The associated byte.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Byte.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getByte
byte getByte(String key, byte defaultValue)(Code)
Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated byte.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Byte.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getByte
Byte getByte(String key, Byte defaultValue)(Code)
Get a byte associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated byte if key is found and has valid format, defaultvalue otherwise.
exception:
  ClassCastException - is thrown if the key maps to an object thatis not a Byte.
exception:
  NumberFormatException - is thrown if the value mapped by the keyhas not a valid number format.

getDouble
double getDouble(String key)(Code)
Get a double associated with the given configuration key.
Parameters:
  key - The configuration key. The associated double.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Double.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getDouble
double getDouble(String key, double defaultValue)(Code)
Get a double associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated double.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Double.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getDouble
Double getDouble(String key, Double defaultValue)(Code)
Get a double associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated double if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Double.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getFloat
float getFloat(String key)(Code)
Get a float associated with the given configuration key.
Parameters:
  key - The configuration key. The associated float.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Float.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getFloat
float getFloat(String key, float defaultValue)(Code)
Get a float associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated float.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Float.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getFloat
Float getFloat(String key, Float defaultValue)(Code)
Get a float associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated float if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Float.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getInt
int getInt(String key)(Code)
Get a int associated with the given configuration key.
Parameters:
  key - The configuration key. The associated int.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Integer.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getInt
int getInt(String key, int defaultValue)(Code)
Get a int associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated int.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Integer.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getInteger
Integer getInteger(String key, Integer defaultValue)(Code)
Get a int associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated int if key is found and has valid format, defaultvalue otherwise.
exception:
  ClassCastException - is thrown if the key maps to an object thatis not a Integer.
exception:
  NumberFormatException - is thrown if the value mapped by the keyhas not a valid number format.

getKeys
Iterator getKeys(String prefix)(Code)
Get the list of the keys contained in the configuration repository that match the specified prefix.
Parameters:
  prefix - The prefix to test against. An Iterator of keys that match the prefix.

getKeys
Iterator getKeys()(Code)
Get the list of the keys contained in the configuration repository. An Iterator.

getLong
long getLong(String key)(Code)
Get a long associated with the given configuration key.
Parameters:
  key - The configuration key. The associated long.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Long.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getLong
long getLong(String key, long defaultValue)(Code)
Get a long associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated long.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Long.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getLong
Long getLong(String key, Long defaultValue)(Code)
Get a long associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated long if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Long.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getProperties
Properties getProperties(String key)(Code)
Get a list of properties associated with the given configuration key.
Parameters:
  key - The configuration key. The associated properties if key is found.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a String/Vector.
exception:
  IllegalArgumentException - if one of the tokens ismalformed (does not contain an equals sign).

getProperty
Object getProperty(String key)(Code)
Gets a property from the configuration.
Parameters:
  key - property to retrieve value as object. Will return user value if exists,if not then default value if exists, otherwise null

getShort
short getShort(String key)(Code)
Get a short associated with the given configuration key.
Parameters:
  key - The configuration key. The associated short.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Short.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getShort
short getShort(String key, short defaultValue)(Code)
Get a short associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated short.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Short.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.

getShort
Short getShort(String key, Short defaultValue)(Code)
Get a short associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated short if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Short.
exception:
  NumberFormatException - is thrown if the value mappedby the key has not a valid number format.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.

getString
String getString(String key)(Code)
Get a string associated with the given configuration key.
Parameters:
  key - The configuration key. The associated string.
exception:
  ClassCastException - is thrown if the key maps to an object thatis not a String.
exception:
  java.util.NoSuchElementException - is thrown if the key doesn'tmap to an existing object.

getString
String getString(String key, String defaultValue)(Code)
Get a string associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated string if key is found and has validformat, default value otherwise.
exception:
  ClassCastException - is thrown if the key maps to an object thatis not a String.

getStringArray
String[] getStringArray(String key)(Code)
Get an array of strings associated with the given configuration key.
Parameters:
  key - The configuration key. The associated string array if key is found.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a String/Vector of Strings.

getVector
Vector getVector(String key)(Code)
Get a Vector of strings associated with the given configuration key.
Parameters:
  key - The configuration key. The associated Vector.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Vector.

getVector
Vector getVector(String key, Vector defaultValue)(Code)
Get a Vector of strings associated with the given configuration key.
Parameters:
  key - The configuration key.
Parameters:
  defaultValue - The default value. The associated Vector.
exception:
  ClassCastException - is thrown if the key maps to anobject that is not a Vector.

isEmpty
boolean isEmpty()(Code)
Check if the configuration is empty. true is the configuration contains no key/value pair, false otherwise

setProperty
void setProperty(String key, Object value)(Code)
Set a property, this will replace any previously set values. Set values is implicitly a call to clearProperty(key), addProperty(key,value).
Parameters:
  key - The key of the property to change
Parameters:
  value - The new value

subset
Configuration subset(String prefix)(Code)
Create an Configuration object that is a subset of this one. The new Configuration object contains every key from the current Configuration that starts with prefix. The prefix is removed from the keys in the subset.
Parameters:
  prefix - The prefix used to select the properties.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.