1/*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.tools.internal.xjc.api;
27
28import com.sun.codemodel.internal.JAnnotatable;
29import com.sun.codemodel.internal.JType;
30
31/**
32 * Java type and associated JAXB annotations.
33 *
34 * @author Kohsuke Kawaguchi
35 */
36public interface TypeAndAnnotation {
37    /**
38     * Returns the Java type.
39     *
40     * <p>
41     * {@link JType} is a representation of a Java type in a codeModel.
42     * If you just need the fully-qualified class name, call {@link JType#fullName()}.
43     *
44     * @return
45     *      never be null.
46     */
47    JType getTypeClass();
48
49    /**
50     * Annotates the given program element by additional JAXB annotations that need to be there
51     * at the point of reference.
52     */
53    void annotate( JAnnotatable programElement );
54
55    /**
56     * Two {@link TypeAndAnnotation} are equal if they
57     * has the same type and annotations.
58     */
59    boolean equals(Object o);
60}
61