summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/model/src/main/java/org/apache/tuscany/model/util/ModelContentHandler.java
blob: 515d2128ec33030148054a0734d09b9b79520723 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/**
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed 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.tuscany.model.util;

import java.util.List;
import java.util.Map;

/**
 * A model content handler. This mimics a SAX content handler for models and
 * receives notification of the content of a model. A model content handler is
 * responsible for handling model content notifications. As part of the handling
 * the handler can produce new contents.
 */
public interface ModelContentHandler {

	/**
	 * Starts handling of a model.
	 */
	public void startModel();

	/**
	 * Ends handling of a model.
	 */
	public void endModel();

	/**
	 * Sets the contents list, where the content handler should store
	 * the contents that it produces.
	 * @param contents The contents to set
	 */
	public void setContents(List contents);

	/**
	 * Sets the linkers list. A content handler can add linker objects to this
	 * list. Linker objects must implement java.lang.Runnable. They are
	 * run as part of the endModel notification processing.
	 * Typically linker objects are used to resolve model forward references
	 * or establish model relationships after the model content has been
	 * handled.
	 * @param linkers The linkers to set
	 */
	public void setLinkers(List linkers);

	/**
	 * Sets the targets map. This map keeps track of the objects returned by
	 * the content handler for each object passed to its doSwitch method.
	 * @param targets The targets to set
	 */
	public void setTargets(Map targets);

	/**
	 * This method dispatches handling of the given object (XYZ for example) to a
	  * corresponding "caseXYZ()" method on the content handler.
	 */
	public Object doSwitch(Object object);

}