001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.lang;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import javax.annotation.Nonnull;
026import javax.annotation.meta.TypeQualifierDefault;
027
028/**
029 * A common Spring annotation to declare that parameters and return values
030 * are to be considered as non-nullable by default for a given package.
031 *
032 * <p>Leverages JSR-305 meta-annotations to indicate nullability in Java to common
033 * tools with JSR-305 support and used by Kotlin to infer nullability of Spring API.
034 *
035 * <p>Should be used at package level in association with {@link Nullable}
036 * annotations at parameter and return value level.
037 *
038 * @author Sebastien Deleuze
039 * @author Juergen Hoeller
040 * @since 5.0
041 * @see NonNullFields
042 * @see Nullable
043 * @see NonNull
044 */
045@Target(ElementType.PACKAGE)
046@Retention(RetentionPolicy.RUNTIME)
047@Documented
048@Nonnull
049@TypeQualifierDefault({ElementType.METHOD, ElementType.PARAMETER})
050public @interface NonNullApi {
051}