1 /* 2 * The contents of this file are subject to the terms 3 * of the Common Development and Distribution License 4 * (the License). You may not use this file except in 5 * compliance with the License. 6 * 7 * You can obtain a copy of the license at 8 * https://glassfish.dev.java.net/public/CDDLv1.0.html or 9 * glassfish/bootstrap/legal/CDDLv1.0.txt. 10 * See the License for the specific language governing 11 * permissions and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL 14 * Header Notice in each file and include the License file 15 * at glassfish/bootstrap/legal/CDDLv1.0.txt. 16 * If applicable, add the following below the CDDL Header, 17 * with the fields enclosed by brackets [] replaced by 18 * you own identifying information: 19 * "Portions Copyrighted [year] [name of copyright owner]" 20 * 21 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 22 */ 23 24 /** 25 * Provides the classes necessary to process J2SE 1.5 annotations in the context 26 * of the J2EE application server. 27 * 28 * <p> 29 * Annotations are defined by their annotation type. This tool assumes that 30 * annotation handlers will be registered to it to process a particular annotation 31 * type. These annotation handlers have no particular knowledge outside of the 32 * annotation they process and the annoted element on which the annotation was 33 * defined. 34 * </p> 35 * <p> 36 * The AnnotationProcessor tool implementation is responsible for maintening a 37 * list of annotations handlers per annotation type. AnnotationHandler are added 38 * to the tool through the pushAnnotationHandler and can be removed through the 39 * popAnnotationHandler. Alternatively, the Factory singleton can be used to get 40 * an initialized AnnotationProcessor with all the default AnnotationHandler. 41 * </p> 42 * <p> 43 * The tool uses the ProcessingContext to have access to Class instances. Each 44 * class instance will be processed in order, and if annotations are present, the 45 * tool will also process Field, Constructor and Methods elements. Each time the 46 * annotation processor switches for one particular AnnotatedElement to another, 47 * it will send start and stop events to any AnnotatedElementHandler interface 48 * implementation registered within the ProcessingContext. This allow client 49 * code to keep context information about the AnnotatedElements being 50 * processed since AnnotationHandler only know about the AnnotatedElement the 51 * annotation was defined on. 52 * </p> 53 * @since 9.0 54 * @auther Jerome Dochez 55 */ 56 package com.sun.enterprise.deployment.annotation;