01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package javax.annotation.processing;
27:
28: /**
29: * A suggested {@linkplain Processor#getCompletions <em>completion</em>} for an
30: * annotation. A completion is text meant to be inserted into a
31: * program as part of an annotation.
32: *
33: * @author Joseph D. Darcy
34: * @author Scott Seligman
35: * @author Peter von der Ahé
36: * @version 1.8 07/05/05
37: * @since 1.6
38: */
39: public interface Completion {
40:
41: /**
42: * Returns the text of the suggested completion.
43: * @return the text of the suggested completion.
44: */
45: String getValue();
46:
47: /**
48: * Returns an informative message about the completion.
49: * @return an informative message about the completion.
50: */
51: String getMessage();
52: }
|