io.hotmoka.whitelisting.WhiteListingProofObligation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-hotmoka-whitelisting Show documentation

This module defines the implementation of white-listing in Hotmoka. It is used to define a subset of Java that can be used for Takamaka smart contracts.

There is a newer version: 1.6.0

Show newest version

/*
Copyright 2021 Fausto Spoto

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package io.hotmoka.whitelisting;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * States that an annotation is meant to decorate an argument of a method
 * or constructor of a white-listed method and specifies some property that
 * the argument must satisfy, for the method to be white-listed.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
@Documented
public @interface WhiteListingProofObligation {

	/**
	 * Yields the class of the predicate that can be used to check
	 * if a value satisfies this proof obligation.
	 * 
	 * @return the class of the predicate
	 */
	Class check();
}