/*

 * 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 jdk.jshell.Key.ErroneousKey;

/**

 * A snippet of code that is not valid Java programming language code.

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

 * <p>

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

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

 * and thus is thread-safe.

 */

public class ErroneousSnippet extends Snippet {

    private final Kind probableKind;

    ErroneousSnippet(ErroneousKey key, String userSource, Wrap guts,

            Kind probableKind, SubKind subkind) {

        super(key, userSource, guts, null, subkind, null);

        this.probableKind = probableKind;

    }

    /**

     * Returns what appears to be the intended Kind in this erroneous snippet.

     *

     * @return the probable Kind; or {@link Kind#ERRONEOUS} if that cannot be

     * determined.

     */

    public Kind probableKind() {

        return probableKind;

    }

}