org.apache.avalon.composition.data
Class ImportDirective

java.lang.Object
  extended byorg.apache.avalon.composition.data.EntryDirective
      extended byorg.apache.avalon.composition.data.ImportDirective
All Implemented Interfaces:
Serializable

public class ImportDirective
extends EntryDirective

An inport directive used within a context directive to request a container scoped values.

XML

An import statement declares that a context value must be supplied by the container, using the container scoped value of the name attribute, and that the value should be supplied as a context entry keyed under the value of the key attribute.


    
    <--
    Declare the import of the value of "urn:avalon:home" as a keyed context
    entry using the key "home".
    -->

  <context>
    <entry key="home">>
      <import key="urn:avalon:home"/>
    </entry>
  </context>
 

Version:
$Revision: 1.3 $ $Date: 2004/01/24 23:25:24 $
Author:
Avalon Development Team
See Also:
ContextDirective, EntryDirective, Parameter, Serialized Form

Constructor Summary
ImportDirective(String key, String containerKey)
          Creation of a new entry directive.
 
Method Summary
 String getImportKey()
          Return the container scoped key that defines the object to be imported.
 
Methods inherited from class org.apache.avalon.composition.data.EntryDirective
getKey
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImportDirective

public ImportDirective(String key,
                       String containerKey)
Creation of a new entry directive.

Parameters:
key - the context entry key
containerKey - the container scoped key value to import
Method Detail

getImportKey

public String getImportKey()
Return the container scoped key that defines the object to be imported.

Returns:
the contain scoped key


Copyright © The Apache Software Foundation. All Rights Reserved.