Source Code Cross Referenced for Annotation.java in  » 6.0-JDK-Core » lang » java » lang » annotation » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » lang » java.lang.annotation 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


001        /*
002         * Copyright 2003-2004 Sun Microsystems, Inc.  All Rights Reserved.
003         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004         *
005         * This code is free software; you can redistribute it and/or modify it
006         * under the terms of the GNU General Public License version 2 only, as
007         * published by the Free Software Foundation.  Sun designates this
008         * particular file as subject to the "Classpath" exception as provided
009         * by Sun in the LICENSE file that accompanied this code.
010         *
011         * This code is distributed in the hope that it will be useful, but WITHOUT
012         * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013         * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014         * version 2 for more details (a copy is included in the LICENSE file that
015         * accompanied this code).
016         *
017         * You should have received a copy of the GNU General Public License version
018         * 2 along with this work; if not, write to the Free Software Foundation,
019         * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020         *
021         * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022         * CA 95054 USA or visit www.sun.com if you need additional information or
023         * have any questions.
024         */
025
026        package java.lang.annotation;
027
028        /**
029         * The common interface extended by all annotation types.  Note that an
030         * interface that manually extends this one does <i>not</i> define
031         * an annotation type.  Also note that this interface does not itself
032         * define an annotation type.
033         *
034         * @author  Josh Bloch
035         * @since   1.5
036         */
037        public interface Annotation {
038            /**
039             * Returns true if the specified object represents an annotation
040             * that is logically equivalent to this one.  In other words,
041             * returns true if the specified object is an instance of the same
042             * annotation type as this instance, all of whose members are equal
043             * to the corresponding member of this annotation, as defined below:
044             * <ul>
045             *    <li>Two corresponding primitive typed members whose values are
046             *    <tt>x</tt> and <tt>y</tt> are considered equal if <tt>x == y</tt>,
047             *    unless their type is <tt>float</tt> or <tt>double</tt>.
048             *
049             *    <li>Two corresponding <tt>float</tt> members whose values
050             *    are <tt>x</tt> and <tt>y</tt> are considered equal if
051             *    <tt>Float.valueOf(x).equals(Float.valueOf(y))</tt>.
052             *    (Unlike the <tt>==</tt> operator, NaN is considered equal
053             *    to itself, and <tt>0.0f</tt> unequal to <tt>-0.0f</tt>.) 
054             *
055             *    <li>Two corresponding <tt>double</tt> members whose values
056             *    are <tt>x</tt> and <tt>y</tt> are considered equal if
057             *    <tt>Double.valueOf(x).equals(Double.valueOf(y))</tt>.
058             *    (Unlike the <tt>==</tt> operator, NaN is considered equal
059             *    to itself, and <tt>0.0</tt> unequal to <tt>-0.0</tt>.)
060             *
061             *    <li>Two corresponding <tt>String</tt>, <tt>Class</tt>, enum, or
062             *    annotation typed members whose values are <tt>x</tt> and <tt>y</tt>
063             *    are considered equal if <tt>x.equals(y)</tt>.  (Note that this
064             *    definition is recursive for annotation typed members.)
065             *
066             *    <li>Two corresponding array typed members <tt>x</tt> and <tt>y</tt>
067             *    are considered equal if <tt>Arrays.equals(x, y)</tt>, for the
068             *    appropriate overloading of {@link java.util.Arrays#equals}.
069             * </ul>
070             *
071             * @return true if the specified object represents an annotation
072             *     that is logically equivalent to this one, otherwise false
073             */
074            boolean equals(Object obj);
075
076            /**
077             * Returns the hash code of this annotation, as defined below:
078             *
079             * <p>The hash code of an annotation is the sum of the hash codes
080             * of its members (including those with default values), as defined
081             * below:
082             *
083             * The hash code of an annotation member is (127 times the hash code
084             * of the member-name as computed by {@link String#hashCode()}) XOR
085             * the hash code of the member-value, as defined below:
086             *
087             * <p>The hash code of a member-value depends on its type:
088             * <ul>
089             * <li>The hash code of a primitive value <tt><i>v</i></tt> is equal to
090             *     <tt><i>WrapperType</i>.valueOf(<i>v</i>).hashCode()</tt>, where
091             *     <tt><i>WrapperType</i></tt> is the wrapper type corresponding
092             *     to the primitive type of <tt><i>v</i></tt> ({@link Byte},
093             *     {@link Character}, {@link Double}, {@link Float}, {@link Integer},
094             *     {@link Long}, {@link Short}, or {@link Boolean}).
095             *
096             * <li>The hash code of a string, enum, class, or annotation member-value
097             I     <tt><i>v</i></tt> is computed as by calling
098             *     <tt><i>v</i>.hashCode()</tt>.  (In the case of annotation
099             *     member values, this is a recursive definition.)
100             *
101             * <li>The hash code of an array member-value is computed by calling
102             *     the appropriate overloading of
103             *     {@link java.util.Arrays#hashCode(long[]) Arrays.hashCode}
104             *     on the value.  (There is one overloading for each primitive
105             *     type, and one for object reference types.)
106             * </ul>
107             *
108             * @return the hash code of this annotation
109             */
110            int hashCode();
111
112            /**
113             * Returns a string representation of this annotation.  The details
114             * of the representation are implementation-dependent, but the following
115             * may be regarded as typical:
116             * <pre>
117             *   &#064;com.acme.util.Name(first=Alfred, middle=E., last=Neuman)
118             * </pre>
119             *
120             * @return a string representation of this annotation
121             */
122            String toString();
123
124            /**
125             * Returns the annotation type of this annotation.
126             */
127            Class<? extends Annotation> annotationType();
128        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.