KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > annotation > processing > Completion


1 /*
2  * @(#)Completion.java 1.2 06/07/31
3  *
4  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package javax.annotation.processing;
9
10 /**
11  * A suggested {@linkplain Processor#getCompletions <em>completion</em>} for an
12  * annotation. A completion is text meant to be inserted into a
13  * program as part of an annotation.
14  *
15  * @author Joseph D. Darcy
16  * @author Scott Seligman
17  * @author Peter von der Ah&eacute;
18  * @version 1.2 06/07/31
19  * @since 1.6
20  */
21 public interface Completion {
22
23     /**
24      * Returns the text of the suggested completion.
25      * @return the text of the suggested completion.
26      */
27     String JavaDoc getValue();
28
29     /**
30      * Returns an informative message about the completion.
31      * @return an informative message about the completion.
32      */
33     String JavaDoc getMessage();
34 }
35
Popular Tags