com.sharneng.annotation.FieldsAreNullableByDefault Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsr305defaults Show documentation

The default annotations to apply JSR305 behavior annotations at package and class level

The newest version!

/*
 * Copyright (c) 2013 Original Authors
 *
 * 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.sharneng.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import javax.annotation.Nullable;
import javax.annotation.meta.TypeQualifierDefault;

/**
 * This annotation can be applied to a package, class to indicate that the
 * fields in that element are nullable by default. Unless there is:
 * 
 * An explicit nullness annotation
 * 
there is a default annotation applied to a more tightly nested element.
 * 
 * 
 * This annotation implies the same "nullness" as no annotation. However, it is
 * different than having no annotation, as it is inherited and it can override a
 * default annotation at an outer scope.
 * 
 */

@Documented
@Nullable
@TypeQualifierDefault(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldsAreNullableByDefault {
}