mcconnell 2002/11/11 02:31:11 Added: meta/src/java/org/apache/excalibur/meta/model Import.java Log: Initial commit of the Import class. The import class represents the resolution of a context value though importing of the value from a hosting container. Revision Changes Path 1.1 jakarta-avalon-excalibur/meta/src/java/org/apache/excalibur/meta/model/Import.java Index: Import.java =================================================================== /* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software * itself, if and wherever such third-party acknowledgments * normally appear. * * 4. The names "Jakarta", "Avalon", and "Apache Software Foundation" * must not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ package org.apache.excalibur.meta.model; /** * An inport directive used within a context directive to request a container scoped values. * * <p><b>XML</b></p> * <p>An import statement declares that a context value must be supplied by the container, * using the container scoped value of the <code>name</code> attribute, and that the value should be * supplied as a context entry keyed under the value of the <code>key</code> attribute.</p> * <pre> * * <font color="gray"> * <-- * Declare the import of the value of "avalon:home" as a keyed context * value using the key "home". * --></font> * * <font color="gray"><context></font> * <import key="<font color="darkred">home</font>" name="<font color="darkred">avalon:home</font>">; * <font color="gray"></context></font> * </pre> * * Imported context entries may be referenced by parameter values using the * "<code>${<key>}</code>" notation. * * @see ContextDirective * @see Entry * @see Parameter * @author <a href="mailto:mcconnell@;apache.org">Stephen McConnell</a> * @version $Revision: 1.1 $ $Date: 2002/11/11 10:31:11 $ */ public class Import { /** * The local key. */ private final String m_key; /** * The container's context entry key. */ private final String m_name; /** * Creation of a new entry directive. * @param key the local key that will be used by clients to access the object via a context * @param name the container scoped context entry name */ public Import( final String key, final String name ) { if( null == key ) { throw new NullPointerException( "key" ); } m_key = key; if( null == name ) { m_name = key; } else { m_name = name; } } /** * Returns the key of the context entry to import. * @return the import key value */ public String getImportName() { return m_name; } /** * Return the key that will be used by a client of a context object to * access the inported value. * * @return the local context key */ public String getKey() { return m_key; } }
-- To unsubscribe, e-mail: <mailto:avalon-cvs-unsubscribe@;jakarta.apache.org> For additional commands, e-mail: <mailto:avalon-cvs-help@;jakarta.apache.org>
