View Javadoc

1   /*
2    * Copyright 2006 Outsource Cafe, Inc.
3    *
4    * Licensed under the Apache License, Version 2.0 (the 'License')
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an 'AS IS' BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.javagen.agile.core.visitor;
17  
18  import java.util.Set;
19  
20  import org.javagen.agile.core.model.Model;
21  
22  /***
23   * Generic visitor interface.  Can limit node visitation using an itinerary.
24   *
25   * @author Richard Easterling
26   */
27  public interface Visitor extends Visit {
28  
29      /***
30       * A way to limit node traversal to a subset of model instances.
31       * @return set of tags defining a subset of model types to visit or null if all nodes should be visited.
32       */
33  	Set<String> itinerary();
34  	
35      /***
36       * Called to perform a specific process on a model instance.  May not be called
37       * if an itinerary is provided that does not match this model instance.
38       * @param model instance to visit.
39       */
40      void visit(Model model);
41      
42  }