donaldp 2002/08/28 04:31:20
Added: containerkit/src/java/org/apache/avalon/framework/info
ComponentBundle.java
Log:
start back porting Spice parts.
The ComponentBundle is the tie together for all
metadata related to a single component.
Revision Changes Path
1.1
jakarta-avalon-excalibur/containerkit/src/java/org/apache/avalon/framework/info/ComponentBundle.java
Index: ComponentBundle.java
===================================================================
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE.txt file.
*/
package org.apache.avalon.framework.info;
import java.io.InputStream;
/**
* The ComponentBundle gives access to the sum total of all the
* metadata and resources about a component. This includes all
* the resources associated with a particular component and the
* associated {@link ComponentInfo}.
*
* <p>Additional resources that may be associated with a component
* include but are not limited to;</p>
*
* <ul>
* <li>Resource property files for i18n of {@link ComponentInfo}</li>
* <li>XML schema or DTD that is used when validating a components
* configuration, such as in Phoenix.</li>
* <li>Descriptor used to define management interface of
* component.</li>
* <li>Prototype used to define a component profile.</li>
* </ul>
*
* @author <a href="mailto:peter at apache.org">Peter Donald</a>
* @version $Revision: 1.1 $ $Date: 2002/08/28 11:31:20 $
*/
public interface ComponentBundle
{
/**
* Return the {@link ComponentInfo} that describes the
* component.
*
* @return the {@link ComponentInfo} that describes the component.
*/
ComponentInfo getComponentInfo();
/**
* Return an input stream for a resource associated with
* component. The resource name can be relative or absolute.
* Absolute names being with a '/' character.
*
* <p>When the component is implemented via a Java class (as
* opposed to a remote SOAP/RMI/JMX/other service), the resources
* are loaded from the same <code>ClassLoader</code> as
* implementation. The resources are loaded relative to the
* implementaion classes package and are often named after the
* classname of the component.</p>
*
* <p>For example, a component <code>com.biz.Foo</code> may have
* resources such as <code>com/biz/Foo-schema.xsd</code>,
* <code>com/biz/Foo.mxinfo</code> or
* <code>com/biz/Foo-profile.xml</code>.</p>
*
* @return the input stream for associated resource, or null
* if no such resource
*/
InputStream getResourceAsStream( String resource );
}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
