java/src/main/com/google/apphosting/api/AppEngineInternal.java

   1 // Copyright 2012 Google. All Rights Reserved.
   2 package com.google.apphosting.api;
   3
   4 import java.lang.annotation.ElementType;
   5 import java.lang.annotation.Retention;
   6 import java.lang.annotation.RetentionPolicy;
   7 import java.lang.annotation.Target;
   8
   9 /**
  10  * Annotation that marks a package or class as internal to App Engine. When
  11  * applied to package, all subpackages are also considered to be internal. User
  12  * code cannot safely depend on any class with this annotation or any class
  13  * belonging to a package or a parent package with this annotation.
  14  *
  15  */
  16 @Retention(RetentionPolicy.RUNTIME)
  17 @Target(value = {ElementType.PACKAGE, ElementType.TYPE})
  18 public @interface AppEngineInternal {
  19
  20   /**
  21    * @return A custom message to be printed when an unsafe reference to an
  22    * internal class is detected.
  23    */
  24   String message() default "";
  25 }