i_info.java

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      TestResultSetToXmlConverter.java
Project:   org.xmlBlasterProject:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
------------------------------------------------------------------------------*/
package org.xmlBlaster.contrib;

import java.util.Set;

/**
 * Hides configuration parameters and passes common objects. 
 * <p>
 * To embed the DbWatcher into your project you need to write
 * a plugin which implements this interface and forwards all calls
 * to you configuration framework.
 * </p>
 * @author Marcel Ruff
 */
public interface I_Info {
   public final static String JMX_PREFIX = "__JMX__";
   /** 
    * This is the key used to identify this instance of the info object. It can be set
    * explicitly or it can be set by the application. For example Implementations such as
    * the GlobalInfo set it per default to be the id of the Plugin (which is the one
    * returned by the PluginInfo.getType()
    */
   public final static String ID = "id";
   
   /**
    * Returns the value associated to this key.
    * @param key
    * @return
    */
   String getRaw(String key);
   
   /**
    * Access a string environment setting. 
    * @param key The parameter key
    * @param def The default used if key is not found
    * @return The configured value of the parameter
    */
   String get(String key, String def);
   
   /**
    * Put key/value to environment. This put does not modify (replace) the key, nor the value.  
    * @param key The parameter key
    * @param value The parameter value, if null the parameter is removed.
    * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>.
    */
   void putRaw(String key, String value);
        
   /**
    * Put key/value to environment.  
    * @param key The parameter key
    * @param value The parameter value, if null the parameter is removed.
    * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>.
    */
   void put(String key, String value);
        
   /**
    * Access an environment setting of type long. 
    * @param key The parameter key
    * @param def The default used if key is not found
    * @return The configured value of the parameter
    */
   long getLong(String key, long def);
        
   /**
    * Access an environment setting of type int. 
    * @param key The parameter key
    * @param def The default used if key is not found
    * @return The configured value of the parameter
    */
   int getInt(String key, int def);

   /**
    * Access an environment setting of type boolean. 
    * @param key The parameter key
    * @param def The default used if key is not found
    * @return The configured value of the parameter
    */
   boolean getBoolean(String key, boolean def);

   /**
    * Store an object.  
    * @param key The object key
    * @param o The object to remember or null to remove it
    * @return The old object or null
    */
   Object putObject(String key, Object o);

   /**
    * Access the remembered object.  
    * @param key The object key
    * @return The found object or null
    */
   Object getObject(String key);
   
   /**
    * Gets the keys of the entries stored. Note that this does not return the
    * key of the entries stored as objects. To retrieve these use getObjectKeys().
    * @return
    */
   Set getKeys();
   
   /**
    * Gets the keys of the objects registered. Note that this does not return the
    * key of the normal entries. To retrieve these use getKeys().
    * @return
    */
   Set getObjectKeys();
   
}