01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.internal.xjc.api;
27:
28: /**
29: * Callback interface that allows the driver of the XJC API
30: * to rename JAXB-generated classes/interfaces/enums.
31: *
32: * @author Kohsuke Kawaguchi
33: */
34: public interface ClassNameAllocator {
35: /**
36: * Hook that allows the client of the XJC API to rename some of the JAXB-generated classes.
37: *
38: * <p>
39: * When registered, this calllbcak is consulted for every package-level
40: * classes/interfaces/enums (hereafter, simply "classes")
41: * that the JAXB RI generates. Note that
42: * the JAXB RI does not use this allocator for nested/inner classes.
43: *
44: * <p>
45: * If the allocator chooses to rename some classes. It is
46: * the allocator's responsibility to find unique names.
47: * If the returned name collides with other classes, the JAXB RI will
48: * report errors.
49: *
50: * @param packageName
51: * The package name, such as "" or "foo.bar". Never be null.
52: * @param className
53: * The short name of the proposed class name. Such as
54: * "Foo" or "Bar". Never be null, never be empty.
55: * Always a valid Java identifier.
56: *
57: * @return
58: * The short name of the class name that should be used.
59: * The class will be generated into the same package with this name.
60: * The return value must be a valid Java identifier. May not be null.
61: */
62: String assignClassName(String packageName, String className);
63: }
|