/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2014 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/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 packager/legal/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.xml.bind.api;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.Collection;
import javax.xml.namespace.QName;
/**
* A reference to a JAXB-bound type.
*
* <p>
* <b>Subject to change without notice</b>.
*
* @since 2.0 EA1
* @author Kohsuke Kawaguchi
*/
public final class TypeReference {
/**
* The associated XML element name that the JAX-RPC uses with this type reference.
*
* Always non-null. Strings are interned.
*/
public final QName tagName;
/**
* The Java type that's being referenced.
*
* Always non-null.
*/
public final Type type;
/**
* The annotations associated with the reference of this type.
*
* Always non-null.
*/
public final Annotation[] annotations;
public TypeReference(QName tagName, Type type, Annotation... annotations) {
if(tagName==null || type==null || annotations==null) {
String nullArgs = "";
if(tagName == null) nullArgs = "tagName";
if(type == null) nullArgs += (nullArgs.length() > 0 ? ", type" : "type");
if(annotations == null) nullArgs += (nullArgs.length() > 0 ? ", annotations" : "annotations");
Messages.ARGUMENT_CANT_BE_NULL.format(nullArgs);
throw new IllegalArgumentException(Messages.ARGUMENT_CANT_BE_NULL.format(nullArgs));
}
this.tagName = new QName(tagName.getNamespaceURI().intern(), tagName.getLocalPart().intern(), tagName.getPrefix());
this.type = type;
this.annotations = annotations;
}
/**
* Finds the specified annotation from the array and returns it.
* Null if not found.
*/
public <A extends Annotation> A get( Class<A> annotationType ) {
for (Annotation a : annotations) {
if(a.annotationType()==annotationType)
return annotationType.cast(a);
}
return null;
}
/**
* Creates a {@link TypeReference} for the item type,
* if this {@link TypeReference} represents a collection type.
* Otherwise returns an identical type.
*/
public TypeReference toItemType() {
// if we are to reinstitute this check, check JAXB annotations only
// assert annotations.length==0; // not designed to work with adapters.
Type base = Utils.REFLECTION_NAVIGATOR.getBaseClass(type, Collection.class);
if(base==null)
return this; // not a collection
return new TypeReference(tagName, Utils.REFLECTION_NAVIGATOR.getTypeArgument(base,0));
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
TypeReference that = (TypeReference) o;
if (!Arrays.equals(annotations, that.annotations)) return false;
if (!tagName.equals(that.tagName)) return false;
if (!type.equals(that.type)) return false;
return true;
}
@Override
public int hashCode() {
int result = tagName.hashCode();
result = 31 * result + type.hashCode();
result = 31 * result + Arrays.hashCode(annotations);
return result;
}
}