Java Doc for GenericConfigurationEngine.java in » J2EE » fleXive » com » flexive » shared » interfaces » 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 » J2EE » fleXive » com.flexive.shared.interfaces

Source Cross Reference Class Diagram Java Document (Java Doc)

com.flexive.shared.interfaces .GenericConfigurationEngine

All known Subclasses:   com.flexive.core.configuration .GenericConfigurationImpl,
GenericConfigurationEngine
abstract public interface GenericConfigurationEngine (Code)
Generic configuration interface. Provides a generic interface for configuration methods based on the Parameter interface.
author:
   Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
See Also:   com.flexive.core.configuration.GenericConfigurationImpl
See Also:   com.flexive.shared.configuration.Parameter

Method Summary
T get(Parameter<T> parameter)
     Retrieves the value of the given parameter.
T get(Parameter<T> parameter, String key)
     Retrieves the value for the given parameter using the given key.
T get(Parameter<T> parameter, String key, boolean ignoreDefault)
     Retrieves the value for the given parameter using the given key.
Map<String, T> getAll(Parameter<T> parameter)
     Retrieves all key/value pairs stored under the path of the given parameter.
Collection<String> getKeys(Parameter<T> parameter)
     Retrieves all keys stored under the path of the given parameter.
void put(Parameter<T> parameter, T value)
     Set a parameter containing a value of type T.
void put(Parameter<T> parameter, String key, T value)
     Set a parameter containing a value of type T using the given key.
void remove(Parameter<T> parameter)
     Removes a parameter from the database.
void remove(Parameter<T> parameter, String key)
     Removes a parameter from the database using the given key.
void removeAll(Parameter<T> parameter)
     Remove all parameters stored under this parameter's path.

Method Detail
get
T get(Parameter<T> parameter) throws FxApplicationException(Code)
Retrieves the value of the given parameter. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter data containing the path and key the value stored under the given path and key
throws:
  FxApplicationException - TODO
throws:
  FxLoadException - if the value could not be loaded
throws:
  FxNotFoundException - if the parameter is not set

get
T get(Parameter<T> parameter, String key) throws FxApplicationException(Code)
Retrieves the value for the given parameter using the given key. This method is useful for getting a single value of aggregate parameters. When all values for an aggregate parameter should be retrieved, use getParameters instead. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter data containing the path
Parameters:
  key - key to be used the value stored under the given path and key
throws:
  FxApplicationException - TODO
throws:
  FxLoadException - if the value could not be loaded
throws:
  FxNotFoundException - if the parameter is not set

get
T get(Parameter<T> parameter, String key, boolean ignoreDefault) throws FxApplicationException(Code)
Retrieves the value for the given parameter using the given key. This method is useful for getting a single value of aggregate parameters. When all values for an aggregate parameter should be retrieved, use getParameters instead. The default value may be disabled through the ignoreDefault parameter, making this method more useful for checking if a parameter exists. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter data containing the path
Parameters:
  key - key to be used
Parameters:
  ignoreDefault - if the parameter's default value should be used default the value stored under the given path and key
throws:
  FxApplicationException - TODO
throws:
  FxLoadException - if the value could not be loaded
throws:
  FxNotFoundException - if the parameter is not set

getAll
Map<String, T> getAll(Parameter<T> parameter) throws FxApplicationException(Code)
Retrieves all key/value pairs stored under the path of the given parameter. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter data containing the path all key/value-pairs under the given path
throws:
  FxApplicationException - TODO
throws:
  FxLoadException - when an error occured reading the keys

getKeys
Collection<String> getKeys(Parameter<T> parameter) throws FxApplicationException(Code)
Retrieves all keys stored under the path of the given parameter. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter containing the path all keys stored under the path of the given parameter.
throws:
  FxApplicationException - TODO

put
void put(Parameter<T> parameter, T value) throws FxApplicationException(Code)
Set a parameter containing a value of type T. <
Parameters:
  T - > value type to be set (e.g. String, Integer, ...)
Parameters:
  parameter - parameter data containing path and key
Parameters:
  value - value to be set
throws:
  FxApplicationException - TODO
throws:
  FxUpdateException - if the value could not be set or updated
throws:
  FxNoAccessException - if the caller is not allowed to update/set this parameter

put
void put(Parameter<T> parameter, String key, T value) throws FxApplicationException(Code)
Set a parameter containing a value of type T using the given key. This method is useful for setting aggregate parameters with varying keys. Use getParameters(Parameter<T&g;t parameter) to retrieve a map with all keys stored under the path of the given parameter. <
Parameters:
  T - > value type to be set
Parameters:
  parameter - parameter data containing the path
Parameters:
  key - key to be used for this value
Parameters:
  value - value to be set
throws:
  FxApplicationException - TODO
throws:
  FxUpdateException - if the value could not be updated
throws:
  FxNoAccessException - if the caller is not allowed to update/set this parameter

remove
void remove(Parameter<T> parameter) throws FxApplicationException(Code)
Removes a parameter from the database. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter to be removed
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - if the parameter could not be removed
throws:
  FxNoAccessException - if the caller is not allowed to remove this parameter

remove
void remove(Parameter<T> parameter, String key) throws FxApplicationException(Code)
Removes a parameter from the database using the given key. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - parameter containing the path to be removed
Parameters:
  key - the key to be removed
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - if the parameter could not be removed
throws:
  FxNoAccessException - if the caller is not allowed to remove this parameter

removeAll
void removeAll(Parameter<T> parameter) throws FxApplicationException(Code)
Remove all parameters stored under this parameter's path. <
Parameters:
  T - > value type of the parameter
Parameters:
  parameter - the parameter to be removed
throws:
  FxApplicationException - TODO
throws:
  com.flexive.shared.exceptions.FxRemoveException - if the parameters could not be removed
throws:
  FxNoAccessException - if the caller is not allowed to remove this parameter

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.