325N/A/*
325N/A * Copyright (c) 1997, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage com.sun.tools.internal.xjc.api;
325N/A
325N/A/**
325N/A * Callback interface that allows the driver of the XJC API
325N/A * to rename JAXB-generated classes/interfaces/enums.
325N/A *
325N/A * @author Kohsuke Kawaguchi
325N/A */
325N/Apublic interface ClassNameAllocator {
325N/A /**
325N/A * Hook that allows the client of the XJC API to rename some of the JAXB-generated classes.
325N/A *
325N/A * <p>
325N/A * When registered, this calllbcak is consulted for every package-level
325N/A * classes/interfaces/enums (hereafter, simply "classes")
325N/A * that the JAXB RI generates. Note that
325N/A * the JAXB RI does not use this allocator for nested/inner classes.
325N/A *
325N/A * <p>
325N/A * If the allocator chooses to rename some classes. It is
325N/A * the allocator's responsibility to find unique names.
325N/A * If the returned name collides with other classes, the JAXB RI will
325N/A * report errors.
325N/A *
325N/A * @param packageName
325N/A * The package name, such as "" or "foo.bar". Never be null.
325N/A * @param className
325N/A * The short name of the proposed class name. Such as
325N/A * "Foo" or "Bar". Never be null, never be empty.
325N/A * Always a valid Java identifier.
325N/A *
325N/A * @return
325N/A * The short name of the class name that should be used.
325N/A * The class will be generated into the same package with this name.
325N/A * The return value must be a valid Java identifier. May not be null.
325N/A */
325N/A String assignClassName( String packageName, String className );
325N/A}