com.wl4g.infra.common.annotation.Nullable Maven / Gradle / Ivy
/*
* Copyright 2017 ~ 2025 the original author or authors. James Wong
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.wl4g.infra.common.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Recommended use {@link javax.annotation.Nullable}
* A common annotation to declare that annotated elements can be {@code null}
* under some circumstance.
*
*
* Leverages JSR-305 meta-annotations to indicate nullability in Java to common
* tools with JSR-305 support and used by Kotlin to infer nullability of common
* API.
*
*
* Should be used at parameter, return value, and field level. Methods override
* should repeat parent {@code @Nullable} annotations unless they behave
* differently.
*
*
* Can be used in association with {@code @NonNullApi} or {@code @NonNullFields}
* to override the default non-nullable semantic to nullable.
*
* @see NonNullApi
* @see NonNullFields
* @see NonNull
* @see {@link javax.annotation.Nullable}
*/
@Target({ ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Deprecated
public @interface Nullable {
}