PersistentSnippet.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
28/**
29 * Grouping for Snippets which persist and influence future code.
30 * A persistent snippet can be
31 * {@linkplain jdk.jshell.Snippet.Status#OVERWRITTEN overwritten)}
32 * with new input and can be dropped {@link JShell#drop}.
33 * <p>
34 * <code>PersistentSnippet</code> is immutable: an access to
35 * any of its methods will always return the same result.
36 * and thus is thread-safe.
37 */
38public abstract class PersistentSnippet extends Snippet {
39
40    PersistentSnippet(Key key, String userSource, Wrap guts, String unitName, SubKind subkind) {
41        super(key, userSource, guts, unitName, subkind);
42    }
43
44    /**
45     * Name of the Snippet.
46     *
47     * @return the name of the snippet.
48     */
49    @Override
50    public String name() {
51        return unitName;
52    }
53}
54