1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/classes/javax/annotation/processing/Completion.java Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,51 @@ 1.4 +/* 1.5 + * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. Sun designates this 1.11 + * particular file as subject to the "Classpath" exception as provided 1.12 + * by Sun in the LICENSE file that accompanied this code. 1.13 + * 1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.17 + * version 2 for more details (a copy is included in the LICENSE file that 1.18 + * accompanied this code). 1.19 + * 1.20 + * You should have received a copy of the GNU General Public License version 1.21 + * 2 along with this work; if not, write to the Free Software Foundation, 1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.23 + * 1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.26 + * have any questions. 1.27 + */ 1.28 + 1.29 +package javax.annotation.processing; 1.30 + 1.31 +/** 1.32 + * A suggested {@linkplain Processor#getCompletions <em>completion</em>} for an 1.33 + * annotation. A completion is text meant to be inserted into a 1.34 + * program as part of an annotation. 1.35 + * 1.36 + * @author Joseph D. Darcy 1.37 + * @author Scott Seligman 1.38 + * @author Peter von der Ahé 1.39 + * @since 1.6 1.40 + */ 1.41 +public interface Completion { 1.42 + 1.43 + /** 1.44 + * Returns the text of the suggested completion. 1.45 + * @return the text of the suggested completion. 1.46 + */ 1.47 + String getValue(); 1.48 + 1.49 + /** 1.50 + * Returns an informative message about the completion. 1.51 + * @return an informative message about the completion. 1.52 + */ 1.53 + String getMessage(); 1.54 +}