Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/annotation/processing/Completion.java@7af634b1fc5b (annotated)
src/share/classes/javax/annotation/processing/Completion.java
Thu, 17 Oct 2013 19:10:19 -0700
- author
- darcy
- date
- Thu, 17 Oct 2013 19:10:19 -0700
- changeset 2145
- 7af634b1fc5b
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8026838: Fix new doclint issues in javax.annotation.processing
Reviewed-by: jjg
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2006, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package javax.annotation.processing; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * A suggested {@linkplain Processor#getCompletions <em>completion</em>} for an |
| duke@1 | 30 | * annotation. A completion is text meant to be inserted into a |
| duke@1 | 31 | * program as part of an annotation. |
| duke@1 | 32 | * |
| duke@1 | 33 | * @author Joseph D. Darcy |
| duke@1 | 34 | * @author Scott Seligman |
| duke@1 | 35 | * @author Peter von der Ahé |
| duke@1 | 36 | * @since 1.6 |
| duke@1 | 37 | */ |
| duke@1 | 38 | public interface Completion { |
| duke@1 | 39 | |
| duke@1 | 40 | /** |
| duke@1 | 41 | * Returns the text of the suggested completion. |
| duke@1 | 42 | * @return the text of the suggested completion. |
| duke@1 | 43 | */ |
| duke@1 | 44 | String getValue(); |
| duke@1 | 45 | |
| duke@1 | 46 | /** |
| duke@1 | 47 | * Returns an informative message about the completion. |
| duke@1 | 48 | * @return an informative message about the completion. |
| duke@1 | 49 | */ |
| duke@1 | 50 | String getMessage(); |
| duke@1 | 51 | } |
