1 /* 2 * Copyright (c) 2009-2010 jMonkeyEngine 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: 8 * 9 * * Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 package com.jme3.system; 33 34 import checkers.quals.TypeQualifier; 35 import java.lang.annotation.*; 36 37 /** 38 * This class contains the Annotation definitions for jME3. Mostly these are used 39 * for code error checking. 40 * @author normenhansen 41 */ 42 public class Annotations { 43 44 /** 45 * Annotation used for math primitive fields, method parameters or method return values. 46 * Specifies that the primitve is read only and should not be changed. 47 */ 48 @Documented 49 @Retention(RetentionPolicy.RUNTIME) 50 @TypeQualifier 51 @Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.TYPE, ElementType.METHOD}) 52 public @interface ReadOnly { 53 } 54 55 /** 56 * Annotation used for methods in math primitives that are destructive to the 57 * object (xxxLocal, setXXX etc.). 58 */ 59 @Documented 60 @Retention(RetentionPolicy.RUNTIME) 61 @TypeQualifier 62 @Target({ElementType.METHOD}) 63 public @interface Destructive { 64 } 65 66 /** 67 * Annotation used for public methods that are not to be called by users. 68 * Examples include update() methods etc. 69 */ 70 public @interface Internal { 71 } 72 } 73
