xdev.lang.NotNull Maven / Gradle / Ivy

Go to download
/*
 * XDEV Application Framework - XDEV Application Framework
 * Copyright © 2003 XDEV Software (https://xdev.software)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package xdev.lang;


import java.lang.annotation.*;


/**
 * A program element annotated @NotNull should always have a value.
 * 
 * 
 * Field: Should be initialized within the class constructors or initializers
 * and not become a null pointer during runtime.
 * 
 * Method: Should never return null
 * 
 * Parameter: Should not be null, otherwise most probable a
 * {@link NullPointerException} is thrown.
 * 
 * 
 * @author XDEV Software Corp.
 * 
 */

@Target({ElementType.FIELD,ElementType.PARAMETER,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotNull
{
}