001 /*
002 * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.annotation.processing;
027
028 /**
029 * A suggested {@linkplain Processor#getCompletions <em>completion</em>} for an
030 * annotation. A completion is text meant to be inserted into a
031 * program as part of an annotation.
032 *
033 * @author Joseph D. Darcy
034 * @author Scott Seligman
035 * @author Peter von der Ahé
036 * @since 1.6
037 */
038 public interface Completion {
039
040 /**
041 * Returns the text of the suggested completion.
042 * @return the text of the suggested completion.
043 */
044 String getValue();
045
046 /**
047 * Returns an informative message about the completion.
048 * @return an informative message about the completion.
049 */
050 String getMessage();
051 }