MetaDataVisitor


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.beans.metadata.spi;
23  
24  import java.util.Stack  ;
25  
26  import org.jboss.dependency.spi.ControllerState;
27  import org.jboss.dependency.spi.DependencyItem;
28  import org.jboss.kernel.spi.dependency.KernelControllerContext;
29  
30  /**
31   * A metadata vistor.
32   * 
33   * @author <a HREF="adrian@jboss.com">Adrian Brock</a>
34   * @version $Revision: 57133 $
35   */
36  public interface MetaDataVisitor
37  {
38     /**
39      * Get the kernel controller context
40      * 
41      * @return the context
42      */
43     KernelControllerContext getControllerContext();
44  
45     /**
46      * Get the context state
47      * 
48      * @return the context state
49      */
50     ControllerState getContextState();
51  
52     /**
53      * Set the context state
54      * 
55      * @param contextState the context state
56      */
57     void setContextState(ControllerState contextState);
58  
59     /**
60      * Add a dependency
61      * 
62      * @param dependency the dependency
63      */
64     void addDependency(DependencyItem dependency);
65     
66     /**
67      * Visit the node
68      * 
69      * @param node the node
70      */
71     void initialVisit(MetaDataVisitorNode node);
72  
73     /**
74      * Revisit the node
75      *
76      * @param node the node
77      */
78     void describeVisit(MetaDataVisitorNode node);
79  
80     /**
81      * Current meta data visited branch
82      *
83      * @return stack of meta data objects in this branch
84      */
85     Stack  <MetaDataVisitorNode> visitorNodeStack();
86  }
87
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags