avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: jakarta-avalon-excalibur/meta/src/java/org/apache/excalibur/meta/model Entry.java
Date Mon, 11 Nov 2002 10:32:34 GMT
mcconnell    2002/11/11 02:32:34

  Added:       meta/src/java/org/apache/excalibur/meta/model Entry.java
  Log:
  Initial commit of the Entry class.  An entry is the declaration of a context
  entry within a ContextDirective.  An entry may be used to construct an
  value based on declarative specification of parameters.
  
  Revision  Changes    Path
  1.1                  jakarta-avalon-excalibur/meta/src/java/org/apache/excalibur/meta/model/Entry.java
  
  Index: Entry.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 apache@apache.org.
   *
   * 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;
  
  /**
   * A entry descriptor declares the context entry creation criteria for
   * a single context entry instance.
   *
   * <p><b>XML</b></p>
   * <p>A entry may container either (a) body content, or (b) a set of constructor
   * parameters to be applied as arguments to a constructor of the supplied classname.</p>
   * <pre>
   *  <font color="gray">&lt;context&gt;</font>
   *    &lt;entry key="<font color="darkred">location</font>"&gt;<font
color="darkred">Paris</font>&lt/entry&gt;;
   *    &lt;entry key="<font color="darkred">home</font>" class="<font
color="darkred">java.io.File</font>"&gt;<font color="darkred">../home</font>&lt/entry&gt;;
   *    &lt;entry key="<font color="darkred">special</font>" class="<font
color="darkred">MyObjectCLass</font>"&gt;
   *      &lt;parameter"&gt;<font color="darkred">Paris</font>&lt/parameter&gt;
   *      &lt;parameter class="<font color="darkred">java.io.File</font>"&gt;<font
color="darkred">../home</font>&lt/parameter&gt;
   *    &lt;/entry&gt;
   *  <font color="gray">&lt;/context&gt;</font>
   * </pre>
   *
   * @see Parameter
   * @see ContextDirective
   * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
   * @version $Revision: 1.1 $ $Date: 2002/11/11 10:32:34 $
   */
  public class Entry extends Parameter
  {
      /**
       * The entry key.
       */
      private final String m_key;
  
      /**
       * Creation of a new entry directive.
       * @param key the entry key
       * @param classname the classname of the entry implementation
       * @param value a single constructor argument value
       */
      public Entry( final String key, final String classname, final String value )
      {
          super( classname, value );
          if( null == key )
          {
              throw new NullPointerException( "key" );
          }
          m_key = key;
      }
  
      /**
       * Creation of a new entry directive.
       * @param key the entry key
       * @param classname the classname of the entry implementation
       * @param parameters implementation class constructor parameter directives
       */
      public Entry( final String key, final String classname, final Parameter[] parameters
)
      {
          super( classname, parameters );
          if( null == key )
          {
              throw new NullPointerException( "key" );
          }
          m_key = key;
      }
  
      /**
       * Return the context key.
       * @return the 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>


Mime
View raw message