/*
* 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.xml.internal.bind.v2.model.impl;
import java.util.Iterator;
import javax.xml.bind.annotation.XmlEnum;
import javax.xml.bind.annotation.XmlEnumValue;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.namespace.QName;
import com.sun.xml.internal.bind.v2.model.annotation.Locatable;
import com.sun.xml.internal.bind.v2.model.core.EnumConstant;
import com.sun.xml.internal.bind.v2.model.core.EnumLeafInfo;
import com.sun.xml.internal.bind.v2.model.core.NonElement;
import com.sun.xml.internal.bind.v2.model.core.Element;
import com.sun.xml.internal.bind.v2.model.core.ClassInfo;
import com.sun.xml.internal.bind.v2.runtime.Location;
/**
* {@link EnumLeafInfo} implementation.
*
* @author Kohsuke Kawaguchi
*/
class EnumLeafInfoImpl<T,C,F,M> extends TypeInfoImpl<T,C,F,M>
implements EnumLeafInfo<T,C>, Element<T,C>, Iterable<EnumConstantImpl<T,C,F,M>> {
/**
* The enum class whose information this object represents.
*/
/*package*/ final C clazz;
NonElement<T,C> baseType;
private final T type;
/**
* Can be null for anonymous types.
*/
private final QName typeName;
/**
* All the {@link EnumConstantImpl}s are linked in this list.
*/
private EnumConstantImpl<T,C,F,M> firstConstant;
/**
* If this enum is also bound to an element, that tag name.
* Or else null.
*/
private QName elementName;
/**
* @param clazz
* @param type
* clazz and type should both point to the enum class
* that this {@link EnumLeafInfo} represents.
* Because of the type parameterization we have to take them separately.
*/
public EnumLeafInfoImpl(ModelBuilder<T,C,F,M> builder,
Locatable upstream, C clazz, T type ) {
super(builder,upstream);
this.clazz = clazz;
this.type = type;
elementName = parseElementName(clazz);
// compute the type name
// TODO: I guess it must be allowed for enums to have @XmlElement
typeName = parseTypeName(clazz);
// locate the base type.
// this can be done eagerly because there shouldn't be no cycle.
XmlEnum xe = builder.reader.getClassAnnotation(XmlEnum.class, clazz, this);
if(xe!=null) {
T base = builder.reader.getClassValue(xe, "value");
baseType = builder.getTypeInfo(base,this);
} else {
baseType = builder.getTypeInfo(builder.nav.ref(String.class),this);
}
}
/**
* Build {@link EnumConstant}s and discover/report any error in it.
*/
protected void calcConstants() {
EnumConstantImpl<T,C,F,M> last = null;
F[] constants = nav().getEnumConstants(clazz);
for( int i=constants.length-1; i>=0; i-- ) {
F constant = constants[i];
String name = nav().getFieldName(constant);
XmlEnumValue xev = builder.reader.getFieldAnnotation(XmlEnumValue.class, constant, this);
String literal;
if(xev==null) literal = name;
else literal = xev.value();
last = createEnumConstant(name,literal,constant,last);
}
this.firstConstant = last;
}
protected EnumConstantImpl<T,C,F,M> createEnumConstant(String name, String literal, F constant, EnumConstantImpl<T,C,F,M> last) {
return new EnumConstantImpl<T,C,F,M>(this, name, literal, last);
}
public T getType() {
return type;
}
/**
* Leaf-type cannot be referenced from IDREF.
*
* @deprecated
* why are you calling a method whose return value is always known?
*/
public final boolean canBeReferencedByIDREF() {
return false;
}
public QName getTypeName() {
return typeName;
}
public C getClazz() {
return clazz;
}
public NonElement<T,C> getBaseType() {
return baseType;
}
public boolean isSimpleType() {
return true;
}
public Location getLocation() {
return nav().getClassLocation(clazz);
}
public Iterable<? extends EnumConstantImpl<T,C,F,M>> getConstants() {
if(firstConstant==null)
calcConstants();
return this;
}
public void link() {
// make sure we've computed constants
getConstants();
super.link();
}
/**
* No substitution.
*
* @deprecated if you are invoking this method directly, there's something wrong.
*/
public Element<T, C> getSubstitutionHead() {
return null;
}
public QName getElementName() {
return elementName;
}
public boolean isElement() {
return elementName!=null;
}
public Element<T,C> asElement() {
if(isElement())
return this;
else
return null;
}
/**
* When a bean binds to an element, it's always through {@link XmlRootElement},
* so this method always return null.
*
* @deprecated
* you shouldn't be invoking this method on {@link ClassInfoImpl}.
*/
public ClassInfo<T,C> getScope() {
return null;
}
public Iterator<EnumConstantImpl<T,C,F,M>> iterator() {
return new Iterator<EnumConstantImpl<T,C,F,M>>() {
private EnumConstantImpl<T,C,F,M> next = firstConstant;
public boolean hasNext() {
return next!=null;
}
public EnumConstantImpl<T,C,F,M> next() {
EnumConstantImpl<T,C,F,M> r = next;
next = next.next;
return r;
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
}