com.sun.tools.xjc.reader.xmlschema.bindinfo.BIEnum Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.xjc.reader.xmlschema.bindinfo;
import java.util.HashMap;
import java.util.Map;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.namespace.QName;
import com.sun.tools.xjc.reader.Const;
import com.sun.tools.xjc.reader.xmlschema.SimpleTypeBuilder;
/**
* Enumeration customization.
*
* This customization binds a simple type to a type-safe enum class.
* The actual binding process takes place in {@link SimpleTypeBuilder}.
*
*
* This customization is acknowledged by {@link SimpleTypeBuilder}.
*
* @author
* Kohsuke Kawaguchi ([email protected])
*/
@XmlRootElement(name="typesafeEnumClass")
public final class BIEnum extends AbstractDeclarationImpl {
/**
* If false, it means not to bind to a type-safe enum.
*
* this takes precedence over all the other properties of this class.
*/
@XmlAttribute(name="map")
private boolean map = true;
/** Gets the specified class name, or null if not specified. */
@XmlAttribute(name="name")
public String className = null;
/**
* @see BIClass#getExistingClassRef()
*/
@XmlAttribute(name="ref")
public String ref;
/**
* Gets the javadoc comment specified in the customization.
* Can be null if none is specified.
*/
@XmlElement
public final String javadoc = null;
public boolean isMapped() {
return map;
}
/**
* Gets the map that contains {@code XML value -> BIEnumMember} pairs.
* This table is built from {@code } customizations.
*
* Always return non-null.
*/
@XmlTransient
public final Map members = new HashMap();
public QName getName() { return NAME; }
public void setParent(BindInfo p) {
super.setParent(p);
for( BIEnumMember mem : members.values() )
mem.setParent(p);
// if this specifies a reference to external class,
// then it's OK even if noone actually refers this class.
if(ref!=null)
markAsAcknowledged();
}
/** Name of this declaration. */
public static final QName NAME = new QName(
Const.JAXB_NSURI, "enum" );
// setter method for JAXB runtime
@XmlElement(name="typesafeEnumMember")
private void setMembers(BIEnumMember2[] mems) {
for (BIEnumMember2 e : mems)
members.put(e.value,e);
}
/**
* {@link BIEnumMember} used inside {@link BIEnum} has additional 'value' attribute.
*/
static class BIEnumMember2 extends BIEnumMember {
/**
* The lexical representaion of the constant to which we are attaching.
*/
@XmlAttribute(required=true)
String value;
}
}