1 /* 2 * Copyright (C) 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.android.safetycenter.annotations; 17 18 import static java.lang.annotation.ElementType.FIELD; 19 import static java.lang.annotation.ElementType.METHOD; 20 import static java.lang.annotation.ElementType.PACKAGE; 21 import static java.lang.annotation.ElementType.PARAMETER; 22 import static java.lang.annotation.RetentionPolicy.CLASS; 23 24 import java.lang.annotation.Retention; 25 import java.lang.annotation.Target; 26 27 import javax.annotation.Nonnull; 28 import javax.annotation.meta.TypeQualifierDefault; 29 30 /** 31 * Specifies that all type uses are {@link Nonnull} within the annotated package, unless tagged with 32 * {@code @Nullable}. This helps IDEs flag all potential nullability issues without having to use 33 * {@code @NonNull} annotations. 34 * 35 * <p>This is similar to {@code @ParametersAreNonnullByDefault}, but is also applied more widely 36 * (e.g. to methods return types and fields). 37 */ 38 @Retention(CLASS) 39 @Target(PACKAGE) 40 @TypeQualifierDefault({PARAMETER, FIELD, METHOD}) 41 @Nonnull // Android variant cannot be applied as a type qualifier. 42 public @interface NonNullByDefault {} 43