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