ExpressionSnippet.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 jdk.jshell.Key.ExpressionKey;
29
30/**
31 * Snippet for an assignment or variable-value expression.
32 * The Kind is {@link jdk.jshell.Snippet.Kind#EXPRESSION}.
33 * <p>
34 * <code>ExpressionSnippet</code> is immutable: an access to
35 * any of its methods will always return the same result.
36 * and thus is thread-safe.
37 * @jls 15: Expression.
38 */
39public class ExpressionSnippet extends Snippet {
40
41    ExpressionSnippet(ExpressionKey key, String userSource, Wrap guts, String name, SubKind subkind) {
42        super(key, userSource, guts, name, subkind);
43    }
44
45    /**
46     * Variable name which is the value of the expression. Since the expression
47     * is either just a variable identifier or it is an assignment
48     * to a variable, there is always a variable which is the subject of the
49     * expression. All other forms of expression become temporary variables
50     * which are instead referenced by a {@link VarSnippet}.
51     * @return the name of the variable which is the subject of the expression.
52     */
53    @Override
54    public String name() {
55        return key().name();
56    }
57
58    /**
59     * Type of the expression
60     * @return String representation of the type of the expression.
61     */
62    public String typeName() {
63        return key().typeName();
64    }
65
66    /**** internal access ****/
67
68    @Override
69    ExpressionKey key() {
70        return (ExpressionKey) super.key();
71    }
72}
73