Completions.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2006, 2012, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.annotation.processing;
27
28/**
29 * Utility class for assembling {@link Completion} objects.
30 *
31 * @author Joseph D. Darcy
32 * @author Scott Seligman
33 * @author Peter von der Ahé
34 * @since 1.6
35 */
36public class Completions {
37    // No instances for you.
38    private Completions() {}
39
40    private static class SimpleCompletion implements Completion {
41        private String value;
42        private String message;
43
44        SimpleCompletion(String value, String message) {
45            if (value == null || message == null)
46                throw new NullPointerException("Null completion strings not accepted.");
47            this.value = value;
48            this.message = message;
49        }
50
51        public String getValue() {
52            return value;
53        }
54
55
56        public String getMessage() {
57            return message;
58        }
59
60        @Override
61        public String toString() {
62            return "[\"" + value + "\", \"" + message + "\"]";
63        }
64        // Default equals and hashCode are fine.
65    }
66
67    /**
68     * Returns a completion of the value and message.
69     *
70     * @param value the text of the completion
71     * @param message a message about the completion
72     * @return a completion of the provided value and message
73     */
74    public static Completion of(String value, String message) {
75        return new SimpleCompletion(value, message);
76    }
77
78    /**
79     * Returns a completion of the value and an empty message
80     *
81     * @param value the text of the completion
82     * @return a completion of the value and an empty message
83     */
84    public static Completion of(String value) {
85        return new SimpleCompletion(value, "");
86    }
87}
88