You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
1.7 KiB
47 lines
1.7 KiB
6 years ago
|
/*
|
||
|
|
* Copyright 2000-2012 JetBrains s.r.o.
|
||
|
|
*
|
||
|
|
* 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 org.jetbrains.annotations;
|
||
|
|
|
||
|
|
import java.lang.annotation.*;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* An element annotated with NotNull claims {@code null} value is <em>forbidden</em>
|
||
|
|
* to return (for methods), pass to (parameters) and hold (local variables and fields).
|
||
|
|
* Apart from documentation purposes this annotation is intended to be used by static analysis tools
|
||
|
|
* to validate against probable runtime errors and element contract violations.
|
||
|
|
*
|
||
|
|
* @author max
|
||
|
|
*/
|
||
|
|
@Documented
|
||
|
|
@Retention(RetentionPolicy.CLASS)
|
||
|
|
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.LOCAL_VARIABLE, ElementType.TYPE_USE})
|
||
|
|
public @interface NotNull {
|
||
|
|
/**
|
||
|
|
* @return Custom exception message
|
||
|
|
*/
|
||
|
|
String value() default "";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return Custom exception type that should be thrown when not-nullity contract is violated.
|
||
|
|
* The exception class should have a constructor with one String argument (message).
|
||
|
|
*
|
||
|
|
* By default, {@link IllegalArgumentException} is thrown on null method arguments and
|
||
|
|
* {@link IllegalStateException} — on null return value.
|
||
|
|
*/
|
||
|
|
Class<? extends Exception> exception() default Exception.class;
|
||
|
|
}
|