01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.tools.xjc.api;
38:
39: /**
40: * Callback interface that allows the driver of the XJC API
41: * to rename JAXB-generated classes/interfaces/enums.
42: *
43: * @author Kohsuke Kawaguchi
44: */
45: public interface ClassNameAllocator {
46: /**
47: * Hook that allows the client of the XJC API to rename some of the JAXB-generated classes.
48: *
49: * <p>
50: * When registered, this calllbcak is consulted for every package-level
51: * classes/interfaces/enums (hereafter, simply "classes")
52: * that the JAXB RI generates. Note that
53: * the JAXB RI does not use this allocator for nested/inner classes.
54: *
55: * <p>
56: * If the allocator chooses to rename some classes. It is
57: * the allocator's responsibility to find unique names.
58: * If the returned name collides with other classes, the JAXB RI will
59: * report errors.
60: *
61: * @param packageName
62: * The package name, such as "" or "foo.bar". Never be null.
63: * @param className
64: * The short name of the proposed class name. Such as
65: * "Foo" or "Bar". Never be null, never be empty.
66: * Always a valid Java identifier.
67: *
68: * @return
69: * The short name of the class name that should be used.
70: * The class will be generated into the same package with this name.
71: * The return value must be a valid Java identifier. May not be null.
72: */
73: String assignClassName(String packageName, String className);
74: }
|