/*

 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.jshell;

import java.util.Collection;

import jdk.jshell.Key.MethodKey;

/**

 * Snippet for a method definition.

 * The Kind is {@link jdk.jshell.Snippet.Kind#METHOD}.

 * <p>

 * <code>MethodSnippet</code> is immutable: an access to

 * any of its methods will always return the same result.

 * and thus is thread-safe.

 * @jls 8.4: MethodDeclaration.

 */

public class MethodSnippet extends DeclarationSnippet {

    final String signature;

    private String qualifiedParamaterTypes;

    MethodSnippet(MethodKey key, String userSource, Wrap guts,

            String name, String signature, Wrap corralled,

            Collection<String> declareReferences, Collection<String> bodyReferences) {

        super(key, userSource, guts, name, SubKind.METHOD_SUBKIND, corralled, declareReferences, bodyReferences);

        this.signature = signature;

    }

    /**

     * A String representation of the parameter types of the method.

     * @return a comma separated list of user entered parameter types for the

     * method.

     */

    public String parameterTypes() {

        return key().parameterTypes();

    }

    /**

     * The full type signature of the method, including return type.

     * @return A String representation of the parameter and return types

     */

    public String signature() {

        return signature;

    }

    @Override

    public String toString() {

        StringBuilder sb = new StringBuilder();

        sb.append("MethodSnippet:");

        sb.append(name());

        sb.append('/');

        sb.append(signature());

        sb.append('-');

        sb.append(source());

        return sb.toString();

    }

    /**** internal access ****/

    @Override

    MethodKey key() {

        return (MethodKey) super.key();

    }

    String qualifiedParameterTypes() {

        return qualifiedParamaterTypes;

    }

    void setQualifiedParamaterTypes(String sig) {

        qualifiedParamaterTypes = sig;

    }

}