/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.tools.internal.xjc.util;
import com.sun.codemodel.internal.ClassType;
import com.sun.codemodel.internal.JClassAlreadyExistsException;
import com.sun.codemodel.internal.JClassContainer;
import com.sun.codemodel.internal.JDefinedClass;
import com.sun.codemodel.internal.JJavaName;
import com.sun.codemodel.internal.JMod;
import com.sun.tools.internal.xjc.ErrorReceiver;
import org.xml.sax.Locator;
import org.xml.sax.SAXParseException;
/**
* Create new {@link JDefinedClass} and report class collision errors,
* if necessary.
*
* This is just a helper class that simplifies the class name collision
* detection. This object maintains no state, so it is OK to use
* multiple instances of this.
*
* @author
* Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*/
public final class CodeModelClassFactory {
/** errors are reported to this object. */
private ErrorReceiver errorReceiver;
/** unique id generator. */
private int ticketMaster = 0;
public CodeModelClassFactory( ErrorReceiver _errorReceiver ) {
this.errorReceiver = _errorReceiver;
}
public JDefinedClass createClass( JClassContainer parent, String name, Locator source ) {
return createClass( parent, JMod.PUBLIC, name, source );
}
public JDefinedClass createClass( JClassContainer parent, int mod, String name, Locator source ) {
return createClass(parent,mod,name,source,ClassType.CLASS);
}
public JDefinedClass createInterface( JClassContainer parent, String name, Locator source ) {
return createInterface( parent, JMod.PUBLIC, name, source );
}
public JDefinedClass createInterface( JClassContainer parent, int mod, String name, Locator source ) {
return createClass(parent,mod,name,source,ClassType.INTERFACE);
}
public JDefinedClass createClass(
JClassContainer parent, String name, Locator source, ClassType kind ) {
return createClass(parent,JMod.PUBLIC,name,source,kind);
}
public JDefinedClass createClass(
JClassContainer parent, int mod, String name, Locator source, ClassType kind ) {
if(!JJavaName.isJavaIdentifier(name)) {
// report the error
errorReceiver.error( new SAXParseException(
Messages.format( Messages.ERR_INVALID_CLASSNAME, name ), source ));
return createDummyClass(parent);
}
try {
if(parent.isClass() && kind==ClassType.CLASS)
mod |= JMod.STATIC;
JDefinedClass r = parent._class(mod,name,kind);
// use the metadata field to store the source location,
// so that we can report class name collision errors.
r.metadata = source;
return r;
} catch( JClassAlreadyExistsException e ) {
// class collision.
JDefinedClass cls = e.getExistingClass();
// report the error
errorReceiver.error( new SAXParseException(
Messages.format( Messages.ERR_CLASSNAME_COLLISION, cls.fullName() ),
(Locator)cls.metadata ));
errorReceiver.error( new SAXParseException(
Messages.format( Messages.ERR_CLASSNAME_COLLISION_SOURCE, name ),
source ));
if( !name.equals(cls.name()) ) {
// on Windows, FooBar and Foobar causes name collision
errorReceiver.error( new SAXParseException(
Messages.format( Messages.ERR_CASE_SENSITIVITY_COLLISION,
name, cls.name() ), null ) );
}
if(Util.equals((Locator)cls.metadata,source)) {
errorReceiver.error( new SAXParseException(
Messages.format( Messages.ERR_CHAMELEON_SCHEMA_GONE_WILD ),
source ));
}
return createDummyClass(parent);
}
}
/**
* Create a dummy class to recover from an error.
*
* We won't generate the code, so the client will never see this class
* getting generated.
*/
private JDefinedClass createDummyClass(JClassContainer parent) {
try {
return parent._class("$$$garbage$$$"+(ticketMaster++));
} catch( JClassAlreadyExistsException ee ) {
return ee.getExistingClass();
}
}
}