aoqi@0: /*
aoqi@0:  * Copyright (c) 2006, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.annotation.processing;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Utility class for assembling {@link Completion} objects.
aoqi@0:  *
aoqi@0:  * @author Joseph D. Darcy
aoqi@0:  * @author Scott Seligman
aoqi@0:  * @author Peter von der Ahé
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: public class Completions {
aoqi@0:     // No instances for you.
aoqi@0:     private Completions() {}
aoqi@0: 
aoqi@0:     private static class SimpleCompletion implements Completion {
aoqi@0:         private String value;
aoqi@0:         private String message;
aoqi@0: 
aoqi@0:         SimpleCompletion(String value, String message) {
aoqi@0:             if (value == null || message == null)
aoqi@0:                 throw new NullPointerException("Null completion strings not accepted.");
aoqi@0:             this.value = value;
aoqi@0:             this.message = message;
aoqi@0:         }
aoqi@0: 
aoqi@0:         public String getValue() {
aoqi@0:             return value;
aoqi@0:         }
aoqi@0: 
aoqi@0: 
aoqi@0:         public String getMessage() {
aoqi@0:             return message;
aoqi@0:         }
aoqi@0: 
aoqi@0:         @Override
aoqi@0:         public String toString() {
aoqi@0:             return "[\"" + value + "\", \"" + message + "\"]";
aoqi@0:         }
aoqi@0:         // Default equals and hashCode are fine.
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns a completion of the value and message.
aoqi@0:      *
aoqi@0:      * @param value the text of the completion
aoqi@0:      * @param message a message about the completion
aoqi@0:      * @return a completion of the provided value and message
aoqi@0:      */
aoqi@0:     public static Completion of(String value, String message) {
aoqi@0:         return new SimpleCompletion(value, message);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns a completion of the value and an empty message
aoqi@0:      *
aoqi@0:      * @param value the text of the completion
aoqi@0:      * @return a completion of the value and an empty message
aoqi@0:      */
aoqi@0:     public static Completion of(String value) {
aoqi@0:         return new SimpleCompletion(value, "");
aoqi@0:     }
aoqi@0: }