org.pkl.thirdparty.truffle.api.dsl.NodeField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation
Show all versions of pkl-tools Show documentation
Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.
/*
* Copyright (c) 2012, 2020, 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.pkl.thirdparty.truffle.api.dsl;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.pkl.thirdparty.truffle.api.CompilerDirectives.CompilationFinal;
import org.pkl.thirdparty.truffle.api.nodes.Node;
/**
* A {@link NodeField} element defines a field for the generated {@link Node}. A {@link Node}
* contains multiple {@link NodeFields} specified in linear declaration order. The field can be
* accessed by declaring an abstract getter or setter named
* "get" + firstLetterUpperCase({@link #name()})()
(or
* "is" + firstLetterUpperCase({@link #name()})()
in case of a boolean node field) and
* "set" + firstLetterUpperCase({@link #name()})()
. If no setter is specified then the
* resulting field will be final and passed in as constructor argument to the create factory method.
* If an abstract setter was specified then the field will be mutable and not passed in as
* constructor argument. Note that the generated mutable field will not be {@link CompilationFinal}.
*
* If the {@link NodeField} is used in combination with {@link GenerateUncached} then the generated
* getters or setters throw an {@link UnsupportedOperationException} for the uncached variant of the
* node.
*
* @see GenerateUncached
* @since 0.8 or earlier
*/
@Retention(RetentionPolicy.CLASS)
@Target({ElementType.TYPE})
@Repeatable(NodeFields.class)
public @interface NodeField {
/** @since 0.8 or earlier */
String name();
/** @since 0.8 or earlier */
Class> type();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy