ImportSnippet.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.ImportKey;
29
30/**
31 * Snippet for an import declaration.
32 * The Kind is {@link jdk.jshell.Snippet.Kind#IMPORT}.
33 * <p>
34 * <code>ImportSnippet</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 8.3: importDeclaration.
38 */
39public class ImportSnippet extends PersistentSnippet {
40
41    final String fullname;
42    final String fullkey;
43    final boolean isStatic;
44    final boolean isStar;
45
46    ImportSnippet(ImportKey key, String userSource, Wrap guts,
47            String fullname, String name, SubKind subkind, String fullkey,
48            boolean isStatic, boolean isStar) {
49        super(key, userSource, guts, name, subkind);
50        this.fullname = fullname;
51        this.fullkey = fullkey;
52        this.isStatic = isStatic;
53        this.isStar = isStar;
54    }
55
56    /**
57     * The identifying name of the import. For on-demand imports
58     * ({@link jdk.jshell.Snippet.SubKind#TYPE_IMPORT_ON_DEMAND_SUBKIND} or
59     * ({@link jdk.jshell.Snippet.SubKind#STATIC_IMPORT_ON_DEMAND_SUBKIND})
60     * that is the full specifier including any
61     * qualifiers and the asterisks. For single imports
62     * ({@link jdk.jshell.Snippet.SubKind#SINGLE_TYPE_IMPORT_SUBKIND} or
63     * ({@link jdk.jshell.Snippet.SubKind#SINGLE_STATIC_IMPORT_SUBKIND}),
64     * it is the imported name. That is, the unqualified name.
65     * @return the name of the import.
66     */
67    @Override
68    public String name() {
69        return key().name();
70    }
71
72    /**
73     *
74     * The qualified name of the import. For any imports
75     * ({@link jdk.jshell.Snippet.SubKind#TYPE_IMPORT_ON_DEMAND_SUBKIND},
76     * ({@link jdk.jshell.Snippet.SubKind#STATIC_IMPORT_ON_DEMAND_SUBKIND}),
77     * ({@link jdk.jshell.Snippet.SubKind#SINGLE_TYPE_IMPORT_SUBKIND} or
78     * ({@link jdk.jshell.Snippet.SubKind#SINGLE_STATIC_IMPORT_SUBKIND})
79     * that is the full specifier including any
80     * qualifiers and the asterisks.
81     * @return the fullname of the import
82     */
83    public String fullname() {
84        return fullname;
85    }
86
87    /**
88     * When this snippet represent static import, this method returns true.
89     * @return true when this snippet represent static import, otherwise false
90     */
91    public boolean isStatic() {
92        return isStatic;
93    }
94
95    /**** internal access ****/
96
97    @Override
98    ImportKey key() {
99        return (ImportKey) super.key();
100    }
101
102    @Override
103    String importLine(JShell state) {
104        return source();
105    }
106}
107