aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.api;
aoqi@0: 
aoqi@0: import java.lang.annotation.Annotation;
aoqi@0: import java.lang.reflect.Type;
aoqi@0: import java.util.Arrays;
aoqi@0: import java.util.Collection;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A reference to a JAXB-bound type.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * <b>Subject to change without notice</b>.
aoqi@0:  *
aoqi@0:  * @since 2.0 EA1
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public final class TypeReference {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The associated XML element name that the JAX-RPC uses with this type reference.
aoqi@0:      *
aoqi@0:      * Always non-null. Strings are interned.
aoqi@0:      */
aoqi@0:     public final QName tagName;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The Java type that's being referenced.
aoqi@0:      *
aoqi@0:      * Always non-null.
aoqi@0:      */
aoqi@0:     public final Type type;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The annotations associated with the reference of this type.
aoqi@0:      *
aoqi@0:      * Always non-null.
aoqi@0:      */
aoqi@0:     public final Annotation[] annotations;
aoqi@0: 
aoqi@0:     public TypeReference(QName tagName, Type type, Annotation... annotations) {
aoqi@0:         if(tagName==null || type==null || annotations==null) {
aoqi@0:             String nullArgs = "";
aoqi@0: 
aoqi@0:             if(tagName == null)     nullArgs = "tagName";
aoqi@0:             if(type == null)        nullArgs += (nullArgs.length() > 0 ? ", type" : "type");
aoqi@0:             if(annotations == null) nullArgs += (nullArgs.length() > 0 ? ", annotations" : "annotations");
aoqi@0: 
aoqi@0:             Messages.ARGUMENT_CANT_BE_NULL.format(nullArgs);
aoqi@0: 
aoqi@0:             throw new IllegalArgumentException(Messages.ARGUMENT_CANT_BE_NULL.format(nullArgs));
aoqi@0:         }
aoqi@0: 
aoqi@0:         this.tagName = new QName(tagName.getNamespaceURI().intern(), tagName.getLocalPart().intern(), tagName.getPrefix());
aoqi@0:         this.type = type;
aoqi@0:         this.annotations = annotations;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Finds the specified annotation from the array and returns it.
aoqi@0:      * Null if not found.
aoqi@0:      */
aoqi@0:     public <A extends Annotation> A get( Class<A> annotationType ) {
aoqi@0:         for (Annotation a : annotations) {
aoqi@0:             if(a.annotationType()==annotationType)
aoqi@0:                 return annotationType.cast(a);
aoqi@0:         }
aoqi@0:         return null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Creates a {@link TypeReference} for the item type,
aoqi@0:      * if this {@link TypeReference} represents a collection type.
aoqi@0:      * Otherwise returns an identical type.
aoqi@0:      */
aoqi@0:     public TypeReference toItemType() {
aoqi@0:         // if we are to reinstitute this check, check JAXB annotations only
aoqi@0:         // assert annotations.length==0;   // not designed to work with adapters.
aoqi@0: 
aoqi@0:         Type base = Utils.REFLECTION_NAVIGATOR.getBaseClass(type, Collection.class);
aoqi@0:         if(base==null)
aoqi@0:             return this;    // not a collection
aoqi@0: 
aoqi@0:         return new TypeReference(tagName, Utils.REFLECTION_NAVIGATOR.getTypeArgument(base,0));
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public boolean equals(Object o) {
aoqi@0:         if (this == o) return true;
aoqi@0:         if (o == null || getClass() != o.getClass()) return false;
aoqi@0: 
aoqi@0:         TypeReference that = (TypeReference) o;
aoqi@0: 
aoqi@0:         if (!Arrays.equals(annotations, that.annotations)) return false;
aoqi@0:         if (!tagName.equals(that.tagName)) return false;
aoqi@0:         if (!type.equals(that.type)) return false;
aoqi@0: 
aoqi@0:         return true;
aoqi@0:     }
aoqi@0: 
aoqi@0:     @Override
aoqi@0:     public int hashCode() {
aoqi@0:         int result = tagName.hashCode();
aoqi@0:         result = 31 * result + type.hashCode();
aoqi@0:         result = 31 * result + Arrays.hashCode(annotations);
aoqi@0:         return result;
aoqi@0:     }
aoqi@0: }