blob: 752ec60b2ecd5556c12962d6dfc0d14ed4c874fb [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.cocoon.components.treeprocessor;
import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.configuration.Configuration;
/**
* A <code>ProcessingNode</code> builder.
* <p>
* Lifecycle information : a <code>TreeBuilder</code> can be recycled
* and used to build several <code>Processor</code>s, each one defining
* a different <code>ComponentManager</code>. As a consequence, a
* <code>ProcessingNodeBuilder</code> that needs access to the
* <code>ComponentManager</code> of the <code>Processor</code> being
* built must be not only <code>Composable</code> but also
* <strong><code>Recomposable</code></strong>.
* <p>
* Note however that being <code>Recomposable</code> doesn't forbid to be
* <code>ThreadSafe</code> since a <code>ProcessingNodeBuilder</code> is
* used by only one <code>TreeBuilder</code> at a time.
*
* @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
* @version CVS $Id$
*/
public interface ProcessingNodeBuilder extends Component {
/**
* Set the builder for which we are building.
*/
void setBuilder(TreeBuilder builder);
/**
* Build the {@link ProcessingNode} and its children from the given
* <code>Configuration</code>, and optionnaly register it in the tree builder
* for lookup by other <code>LinkedProcessingNodeBuilder</code>s.
*/
ProcessingNode buildNode(Configuration config) throws Exception;
}