src/share/classes/javax/annotation/processing/Completion.java

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

Initial load

duke@1 1 /*
duke@1 2 * Copyright 2006 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any 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&eacute;
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 }

mercurial