View Javadoc
1   package net.sourceforge.jenesis4java;
2   
3   /*
4    * #%L
5    * Jenesis 4 Java Code Generator
6    * %%
7    * Copyright (C) 2000 - 2016 jenesis4java
8    * %%
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   * 
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   * 
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * #L%
23   */
24  
25  /**
26   * Visitor implementation that can be used with {@link Codeable} instances.
27   */
28  public interface ReplacingVisitor {
29  
30      /**
31       * This method is called for each field of the visited element. An
32       * implementation can choose to overwrite (or delete) a field by returning
33       * the new value. If no changes are to be made, return the current element.
34       * 
35       * @param current
36       *            The currently visited object.
37       * @param parent
38       *            The parent instance of the visited object. This is the object
39       *            the {@link Codeable#visit} is called on.
40       * @return The new object that is to be used in place of the given visited
41       *         object.
42       */
43      Codeable visitReplace(Codeable current, Codeable parent);
44  
45  }