• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2009 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.common.annotations;
18 
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 
24 /**
25  * The presence of this annotation on a method indicates that the method may
26  * <em>not</em> be used with the
27  * <a href="http://code.google.com/webtoolkit/">Google Web Toolkit</a> (GWT),
28  * even though its type is annotated as {@link GwtCompatible} and accessible in
29  * GWT.  They can cause GWT compilation errors or simply unexpected exceptions
30  * when used in GWT.
31  *
32  * <p>Note that this annotation should only be applied to methods of types which
33  * are annotated as {@link GwtCompatible}.
34  *
35  * @author Charles Fry
36  */
37 @Retention(RetentionPolicy.CLASS)
38 @Target(ElementType.METHOD)
39 // @Documented - uncomment when GWT support is official
40 @GwtCompatible
41 public @interface GwtIncompatible {
42 
43   /**
44    * Describes why the annotated element is incompatible with GWT. Since this is
45    * generally due to a dependence on a type/method which GWT doesn't support,
46    * it is sufficient to simply reference the unsupported type/method. E.g.
47    * "Class.isInstance".
48    */
value()49   String value();
50 
51 }
52