1 /*
2 * Copyright 2006 Werner Guttmann
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.exolab.castor.builder.conflictresolution;
17
18 import org.exolab.castor.builder.SGStateInfo;
19 import org.exolab.castor.builder.SingleClassGenerator;
20 import org.exolab.castor.builder.info.ClassInfo;
21 import org.exolab.castor.util.dialog.ConsoleDialog;
22 import org.exolab.javasource.JClass;
23
24 /**
25 * Strategy pattern for dealing with class name conflicts during source code
26 * generation. The various implementations of this stragtegy will implement
27 * individual approaches for dealing with such a naming collision.
28 *
29 * @author <a href="mailto:werner DOT guttmann AT gmx DOT net">Werner Guttmann</a>
30 * @since 1.1
31 */
32 public interface ClassNameCRStrategy {
33
34 /**
35 * Implements a specific strategy for dealing with class name conflicts.
36 * @param state The current source generator state.
37 * @param newClassInfo The {@link CLassInfo} for the new class to be generated.
38 * @param conflict The {@link JClass} instance representing the potential conflict.
39 * @return the source generator state, as modified by the decision.
40 */
41 SGStateInfo dealWithClassNameConflict(final SGStateInfo state,
42 final ClassInfo newClassInfo, final JClass conflict);
43
44 /**
45 * Implements a specific strategy for dealing with the fact that -- for a
46 * given file name -- an artifact with the same name already exists.
47 *
48 * @param filename The name of the file to be overwritten.
49 * @return True of the file should be overwritten.
50 */
51 boolean dealWithFileOverwrite(String filename);
52
53 /**
54 * Returns the name of this strategy.
55 * @return The name of this strategy.
56 */
57 String getName();
58
59 /**
60 * Sets the {@link ConsoleDialog} instance to use (if required).
61 * @param dialog the {@link ConsoleDialog} instance to use (if required).
62 */
63 void setConsoleDialog(ConsoleDialog dialog);
64
65 /**
66 * Injects the {@link SingleClassGenerator} instance that actually is
67 * calling a method of this strategy.
68 *
69 * @param generator The calling {@link SingleClassGenerator}
70 * @see SingleClassGenerator
71 */
72 void setSingleClassGenerator(SingleClassGenerator generator);
73
74 }