org.glassfish.hk2.utilities.Stub Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2016 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 org.glassfish.hk2.utilities;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.SOURCE;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
/**
* When this annotation is placed on an abstract class the methods of
* the class that are abstract will be generated into a subclass by
* the hk2-metadata-generator along with an empty
* {@link org.jvnet.hk2.annotations.Service} annotation
*
* Any {@link javax.inject.Named} or {@link org.jvnet.hk2.annotations.ContractsProvided}
* annotation on the class marked with this annotation will also be copied to the
* implementation. No other qualifier or annotation will be copied to the concrete
* implementation. However, the {@link org.glassfish.hk2.api.Rank} annotation
* on the stub class will be honored.
*
* The methods generated into the subclass can either return null and fixed
* values (for scalars) or can throw exceptions, depending on the
* {@link Stub.Type} value of this annotation
*
* Using this annotation is useful for testing, though it will work both with
* test code and non-test code
*
* @author jwells
*/
@Documented
@Retention(SOURCE)
@Target( { TYPE} )
public @interface Stub {
/**
* This value determines what the generated methods do
*
* If set to {@link Type#VALUES} then the methods will return
* nulls or fixed values for scalars.
*
* If set to {@link Type#EXCEPTIONS} then the methods will
* throw UnsupportedOperationException
*
* @return The behavior of the generated methods
*/
public Type value() default Type.VALUES;
public enum Type {
/** The generated methods of this stub will return null and fixed values */
VALUES,
/** The generated methods of this stub will throw an UnsupportedOperationException */
EXCEPTIONS
}
}