001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064: package com.jcorporate.expresso.kernel;
065:
066: /**
067: * This interface is a read-only interface into a dyna-bean. It is used
068: * to contracturally enforce a component only being able to read it's own
069: * configuration. DefaultConfigBean is the typical implementation of this interface
070: *
071: * @author Michael Rimov
072: * @see com.jcorporate.expresso.kernel.internal.DefaultConfigBean
073: * @since Expresso 5.1
074: */
075: public interface Configuration {
076:
077: /**
078: * Return the value of a simple property with the specified name
079: *
080: * @param name Name of the property whose value is to be retrieved
081: * @return java.lang.Object representing the property value.
082: * @throws java.lang.IllegalArgumentException
083: * If there is no property of the specified name
084: */
085: public Object get(java.lang.String name);
086:
087: /**
088: * Return the value of an indexed property with the specified name.
089: *
090: * @param name Name of the property whose value is to be retrieved
091: * @param index Index of the value to be retrieved
092: * @return java.lang.Object representing the property value.
093: * @throws java.lang.IllegalArgumentException
094: * if there is no property of the
095: * specified name
096: * @throws java.lang.IndexOutOfBoundsException
097: * If the specified index is
098: * outside the range of the underlying property
099: * @throws java.lang.NullPointerException If no array or List has been
100: * initialized for this property
101: */
102: public Object get(java.lang.String name, int index);
103:
104: /**
105: * Retrieve ALL the indexed properties defined by parameter name.
106: *
107: * @param name the name of the property
108: * @return java.util.List
109: */
110: public java.util.List getIndexedProperties(String name);
111:
112: /**
113: * Return the value of a mapped property with the specified name, or null
114: * if there is no value for the specified key
115: *
116: * @param name Name of the property whose value is to be retrieved
117: * @param key Key of the value to be retrieved
118: * @return java.lang.Object representing the property value.
119: * @throws java.lang.IllegalArgumentException
120: * If there is no property
121: * of the specified name
122: */
123: public Object get(java.lang.String name, java.lang.String key);
124:
125: /**
126: * Retrieved all the mapped properties defined by name
127: *
128: * @param name the name of the mapped properties to retrieve
129: * @return java.util.Map of all properties keyed by the property key.
130: */
131: public java.util.Map getMappedProperties(String name);
132:
133: /**
134: * Does the specified mapped property contain a value for the specified key value?
135: *
136: * @param name Name of the property to check
137: * @param key Name of the key to check
138: * @return true if the property exists.
139: * @throws IllegalArgumentException upon error
140: */
141: public boolean contains(java.lang.String name, java.lang.String key);
142:
143: }
|