MethodSnippet.java revision 3170:dc017a37aac5 
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
26package jdk.jshell;
27
28import java.util.Collection;
29import 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 * @jls 8.4: MethodDeclaration.
39 */
40public class MethodSnippet extends DeclarationSnippet {
41
42    final String signature;
43    private String qualifiedParamaterTypes;
44
45    MethodSnippet(MethodKey key, String userSource, Wrap guts,
46            String name, String signature, Wrap corralled,
47            Collection<String> declareReferences, Collection<String> bodyReferences) {
48        super(key, userSource, guts, name, SubKind.METHOD_SUBKIND, corralled, declareReferences, bodyReferences);
49        this.signature = signature;
50    }
51
52    /**
53     * A String representation of the parameter types of the method.
54     * @return a comma separated list of user entered parameter types for the
55     * method.
56     */
57    public String parameterTypes() {
58        return key().parameterTypes();
59    }
60
61    /**
62     * The full type signature of the method, including return type.
63     * @return A String representation of the parameter and return types
64     */
65    public String signature() {
66        return signature;
67    }
68
69    @Override
70    public String toString() {
71        StringBuilder sb = new StringBuilder();
72        sb.append("MethodSnippet:");
73        sb.append(name());
74        sb.append('/');
75        sb.append(signature());
76        sb.append('-');
77        sb.append(source());
78        return sb.toString();
79    }
80
81    /**** internal access ****/
82
83    @Override
84    MethodKey key() {
85        return (MethodKey) super.key();
86    }
87
88    String qualifiedParameterTypes() {
89        return qualifiedParamaterTypes;
90    }
91
92    void setQualifiedParamaterTypes(String sig) {
93        qualifiedParamaterTypes = sig;
94    }
95}
96