1 /*
   2  * Copyright (c) 2015, 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 
  26 package jdk.jshell;
  27 
  28 import java.util.Collection;
  29 import jdk.jshell.Key.MethodKey;
  30 
  31 /**
  32  * Snippet for a method definition.
  33  * The Kind is {@link jdk.jshell.Snippet.Kind#METHOD}.
  34  * <p>
  35  * <code>MethodSnippet</code> is immutable: an access to
  36  * any of its methods will always return the same result.
  37  * and thus is thread-safe.
  38  *
  39  * @since 9
  40  * @jls 8.4 Method Declarations
  41  */
  42 public class MethodSnippet extends DeclarationSnippet {
  43 
  44     final String signature;
  45     private String qualifiedParameterTypes;
  46 
  47     MethodSnippet(MethodKey key, String userSource, Wrap guts,
  48             String name, String signature, Wrap corralled,
  49             Collection<String> declareReferences, Collection<String> bodyReferences,
  50             DiagList syntheticDiags) {
  51         super(key, userSource, guts, name, SubKind.METHOD_SUBKIND, corralled,
  52                 declareReferences, bodyReferences, syntheticDiags);
  53         this.signature = signature;
  54     }
  55 
  56     /**
  57      * A String representation of the parameter types of the method.
  58      * @return a comma separated list of user entered parameter types for the
  59      * method.
  60      */
  61     public String parameterTypes() {
  62         return key().parameterTypes();
  63     }
  64 
  65     /**
  66      * The full type signature of the method, including return type.
  67      * @return A String representation of the parameter and return types
  68      */
  69     public String signature() {
  70         return signature;
  71     }
  72 
  73     @Override
  74     public String toString() {
  75         StringBuilder sb = new StringBuilder();
  76         sb.append("MethodSnippet:");
  77         sb.append(name());
  78         sb.append('/');
  79         sb.append(signature());
  80         sb.append('-');
  81         sb.append(source());
  82         return sb.toString();
  83     }
  84 
  85     /**** internal access ****/
  86 
  87     @Override
  88     MethodKey key() {
  89         return (MethodKey) super.key();
  90     }
  91 
  92     String qualifiedParameterTypes() {
  93         return qualifiedParameterTypes;
  94     }
  95 
  96     void setQualifiedParameterTypes(String sig) {
  97         qualifiedParameterTypes = sig;
  98     }
  99 }