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    import java.util.Arrays;
029    
030    /**
031     * Utility class for assembling {@link Completion} objects.
032     *
033     * @author Joseph D. Darcy
034     * @author Scott Seligman
035     * @author Peter von der Ahé
036     * @since 1.6
037     */
038    public class Completions {
039        // No instances for you.
040        private Completions() {}
041    
042        private static class SimpleCompletion implements Completion {
043            private String value;
044            private String message;
045    
046            SimpleCompletion(String value, String message) {
047                if (value == null || message == null)
048                    throw new NullPointerException("Null completion strings not accepted.");
049                this.value = value;
050                this.message = message;
051            }
052    
053            public String getValue() {
054                return value;
055            }
056    
057    
058            public String getMessage() {
059                return message;
060            }
061    
062            @Override
063            public String toString() {
064                return "[\"" + value + "\", \"" + message + "\"]";
065            }
066            // Default equals and hashCode are fine.
067        }
068    
069        /**
070         * Returns a completion of the value and message.
071         *
072         * @param value the text of the completion
073         * @param message a message about the completion
074         * @return a completion of the provided value and message
075         */
076        public static Completion of(String value, String message) {
077            return new SimpleCompletion(value, message);
078        }
079    
080        /**
081         * Returns a completion of the value and an empty message
082         *
083         * @param value the text of the completion
084         * @return a completion of the value and an empty message
085         */
086        public static Completion of(String value) {
087            return new SimpleCompletion(value, "");
088        }
089    }