| 1 | /* |
| 2 | * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * 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 | import java.util.Arrays; |
| 29 | |
| 30 | /** |
| 31 | * Utility class for assembling {@link Completion} objects. |
| 32 | * |
| 33 | * @author Joseph D. Darcy |
| 34 | * @author Scott Seligman |
| 35 | * @author Peter von der Ahé |
| 36 | * @since 1.6 |
| 37 | */ |
| 38 | public class Completions { |
| 39 | // No instances for you. |
| 40 | private Completions() {} |
| 41 | |
| 42 | private static class SimpleCompletion implements Completion { |
| 43 | private String value; |
| 44 | private String message; |
| 45 | |
| 46 | SimpleCompletion(String value, String message) { |
| 47 | if (value == null || message == null) |
| 48 | throw new NullPointerException("Null completion strings not accepted."); |
| 49 | this.value = value; |
| 50 | this.message = message; |
| 51 | } |
| 52 | |
| 53 | public String getValue() { |
| 54 | return value; |
| 55 | } |
| 56 | |
| 57 | |
| 58 | public String getMessage() { |
| 59 | return message; |
| 60 | } |
| 61 | |
| 62 | @Override |
| 63 | public String toString() { |
| 64 | return "[\"" + value + "\", \"" + message + "\"]"; |
| 65 | } |
| 66 | // Default equals and hashCode are fine. |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Returns a completion of the value and message. |
| 71 | * |
| 72 | * @param value the text of the completion |
| 73 | * @param message a message about the completion |
| 74 | * @return a completion of the provided value and message |
| 75 | */ |
| 76 | public static Completion of(String value, String message) { |
| 77 | return new SimpleCompletion(value, message); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Returns a completion of the value and an empty message |
| 82 | * |
| 83 | * @param value the text of the completion |
| 84 | * @return a completion of the value and an empty message |
| 85 | */ |
| 86 | public static Completion of(String value) { |
| 87 | return new SimpleCompletion(value, ""); |
| 88 | } |
| 89 | } |