1   /*
2    * Copyright 2018 LINE Corporation
3    *
4    * LINE Corporation licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://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, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package com.linecorp.centraldogma.common.util;
17  
18  import java.lang.annotation.Documented;
19  import java.lang.annotation.ElementType;
20  import java.lang.annotation.Retention;
21  import java.lang.annotation.RetentionPolicy;
22  import java.lang.annotation.Target;
23  
24  import javax.annotation.Nonnull;
25  import javax.annotation.Nullable;
26  import javax.annotation.meta.TypeQualifierDefault;
27  
28  /**
29   * An annotation that signifies the return values, parameters and fields are non-nullable by default
30   * leveraging the JSR-305 {@link Nonnull} annotation. Annotate a package with this annotation and
31   * annotate nullable return values, parameters and fields with {@link Nullable}.
32   */
33  @Nonnull
34  @Documented
35  @Target(ElementType.PACKAGE)
36  @Retention(RetentionPolicy.RUNTIME)
37  @TypeQualifierDefault({ ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.TYPE_USE })
38  public @interface NonNullByDefault {
39  }