01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.components.treeprocessor;
18:
19: import org.apache.avalon.framework.component.Component;
20: import org.apache.avalon.framework.configuration.Configuration;
21:
22: /**
23: * A <code>ProcessingNode</code> builder.
24: * <p>
25: * Lifecycle information : a <code>TreeBuilder</code> can be recycled
26: * and used to build several <code>Processor</code>s, each one defining
27: * a different <code>ComponentManager</code>. As a consequence, a
28: * <code>ProcessingNodeBuilder</code> that needs access to the
29: * <code>ComponentManager</code> of the <code>Processor</code> being
30: * built must be not only <code>Composable</code> but also
31: * <strong><code>Recomposable</code></strong>.
32: * <p>
33: * Note however that being <code>Recomposable</code> doesn't forbid to be
34: * <code>ThreadSafe</code> since a <code>ProcessingNodeBuilder</code> is
35: * used by only one <code>TreeBuilder</code> at a time.
36: *
37: * @author <a href="mailto:sylvain@apache.org">Sylvain Wallez</a>
38: * @version CVS $Id: ProcessingNodeBuilder.java 433543 2006-08-22 06:22:54Z crossley $
39: */
40:
41: public interface ProcessingNodeBuilder extends Component {
42:
43: /**
44: * Set the builder for which we are building.
45: */
46: void setBuilder(TreeBuilder builder);
47:
48: /**
49: * Build the {@link ProcessingNode} and its children from the given
50: * <code>Configuration</code>, and optionnaly register it in the tree builder
51: * for lookup by other <code>LinkedProcessingNodeBuilder</code>s.
52: */
53: ProcessingNode buildNode(Configuration config) throws Exception;
54: }
|