Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2017, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.graalvm.polyglot.tck;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import org.graalvm.polyglot.Value;
/**
* The unit of execution with assigned parameters and result types. The {@link Snippet} represents
* an execution of value constructor, statement, expression and script. The {@link Snippet} provides
* parameter(s) and return types used to compose the {@link Snippet}s.
*
* @since 0.30
*/
public final class Snippet {
private final String id;
private final Value executableValue;
private final TypeDescriptor type;
private final List parameterTypes;
private final ResultVerifier verifier;
private Snippet(
final String id,
final Value executableValue,
final TypeDescriptor type,
final List parameterTypes,
final ResultVerifier verifier) {
if (!executableValue.canExecute()) {
throw new IllegalArgumentException("The executableValue has to be executable.");
}
this.id = id;
this.executableValue = executableValue;
this.type = type;
this.parameterTypes = parameterTypes;
this.verifier = verifier;
}
/**
* Returns the identifier of a snippet. The {@link Snippet}s from a single
* {@link LanguageProvider} with the same identifier but different types are treated as
* overloads.
*
* @return the {@link Snippet} identifier
* @since 0.30
*/
public String getId() {
return id;
}
/**
* Returns the function executing the {@link Snippet}.
*
* @return the executable {@link Value}
* @since 0.30
*/
public Value getExecutableValue() {
return executableValue;
}
/**
* Returns the {@link Snippet} return type.
*
* @return the return type
* @since 0.30
*/
public TypeDescriptor getReturnType() {
return type;
}
/**
* Returns the types of {@link Snippet} formal parameters.
*
* @return the parameter types
* @since 0.30
*/
public List getParameterTypes() {
return parameterTypes;
}
/**
* Returns the {@link ResultVerifier} to verify the execution result.
*
* @return either a custom or the default {@link ResultVerifier}.
* @see ResultVerifier#accept(org.graalvm.polyglot.tck.ResultVerifier.SnippetRun).
* @since 0.30
*/
public ResultVerifier getResultVerifier() {
return verifier;
}
/**
* {@inheritDoc}
*
* @since 0.30
*/
@Override
public String toString() {
return new StringBuilder(id).append(parameterTypes.stream().map(Object::toString).collect(Collectors.joining(", ", "(", ")"))).append(':').append(type).toString();
}
/**
* Creates a new {@link Snippet} builder object.
*
* @param id the {@link Snippet} identifier The {@link Snippet}s from a single
* {@link LanguageProvider} with the same identifier but different types are treated
* as overloads.
* @param executableValue the executable {@link Value} used to execute the {@link Snippet}
* @param executableReturnType the {@link Snippet} return type
* @return the new {@link Builder}
* @since 0.30
*/
public static Builder newBuilder(
final String id,
final Value executableValue,
final TypeDescriptor executableReturnType) {
return new Builder(id, executableValue, executableReturnType);
}
/**
* The builder of a {@link Snippet}.
*
* @since 0.30
*/
public static final class Builder {
private final String id;
private final Value executableValue;
private TypeDescriptor executableReturnType;
private List parameterTypes;
private ResultVerifier verifier;
private Builder(
final String id,
final Value executableValue,
final TypeDescriptor executableReturnType) {
Objects.requireNonNull(id);
Objects.requireNonNull(executableValue);
Objects.requireNonNull(executableReturnType);
this.id = id;
this.executableValue = executableValue;
this.executableReturnType = executableReturnType;
this.parameterTypes = new ArrayList<>();
}
/**
* Sets the {@link Snippet} formal parameter types.
*
* @param parameterTypes the types of {@link Snippet}'s parameters
* @return this {@link Builder}
* @since 0.30
*/
public Builder parameterTypes(@SuppressWarnings("hiding") final TypeDescriptor... parameterTypes) {
Objects.requireNonNull(parameterTypes);
this.parameterTypes = Arrays.asList(parameterTypes);
return this;
}
/**
* Sets a custom verifier of a result of the {@link Snippet} execution.
*
* @param resultVerifier the custom {@link ResultVerifier}
* @return this {@link Builder}
* @see ResultVerifier#accept(org.graalvm.polyglot.tck.ResultVerifier.SnippetRun).
* @since 0.30
*/
public Builder resultVerifier(final ResultVerifier resultVerifier) {
this.verifier = resultVerifier;
return this;
}
/**
* Creates a new {@link Snippet} configured by this {@link Builder}.
*
* @return the {@link Snippet}
* @since 0.30
*/
public Snippet build() {
return new Snippet(
id,
executableValue,
executableReturnType,
Collections.unmodifiableList(parameterTypes),
verifier != null ? verifier : ResultVerifier.getDefaultResultVerifier());
}
}
}
