blob: 1578cf7ad343a70f7f48550069a04a71a58f59f1 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2011 GK Software AG and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Stephan Herrmann - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.annotation;
import static java.lang.annotation.ElementType.*;
import java.lang.annotation.*;
/**
* Qualifier for a type in a method signature or a local variable declaration.
* The entity (return value, parameter, local variable) whose type has this
* annotation can never have the value <code>null</code> at runtime.
* <p>
* This has two consequences:
* <ul>
* <li>An attempt to bind a <code>null</code> value to the entity is a compile time error.
* Diagnostics issued by the compiler should distinguish three situations:
* <ul>
* <li>Nullness of the value can be statically determined.</li>
* <li>Nullness can not definitely be determined, because different code branches yield different results.</li>
* <li>Nullness can not be determined, because other program elements are involved for which
* null annotations are lacking.</li>
* </ul></li>
* <li>Dereferencing the entity is safe, i.e., no <code>NullPointerException</code> can occur at runtime.</li>
* </ul>
* </p>
* @author stephan
*/
@Retention(RetentionPolicy.CLASS)
@Target({METHOD,PARAMETER,LOCAL_VARIABLE})
public @interface NonNull {
}