io.takamaka.code.lang.PayableContract Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io-takamaka-code Show documentation

This module defines the support library of the Takamaka language.

The 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.takamaka.code.lang;

import java.math.BigInteger;

/**
 * A contract that can receive funds from any other contract, through
 * its {@link io.takamaka.code.lang.PayableContract#receive(int)} method.
 * If this class is subclassed, the resulting contract has a balance
 * that is not determined by its payable methods only, but also by the
 * funds received through such receiving methods.
 */
public abstract class PayableContract extends Contract {

	/**
	 * Creates the contract.
	 */
	protected PayableContract() {}

	/**
	 * Receives the given amount of coins from the caller of the method.
	 * 
	 * @param amount the amount of coins
	 */
	@Payable @FromContract
	public final void receive(int amount) {}

	/**
	 * Receives the given amount of coins from the caller of the method.
	 * 
	 * @param amount the amount of coins
	 */
	@Payable @FromContract
	public final void receive(long amount) {}

	/**
	 * Receives the given amount of coins from the caller of the method.
	 * 
	 * @param amount the amount of coins
	 */
	@Payable @FromContract
	public final void receive(BigInteger amount) {}

	/**
	 * Receives the given amount of red coins from the caller of the method.
	 * 
	 * @param amount the amount of red coins
	 */
	@RedPayable @FromContract
	public final void receiveRed(int amount) {}

	/**
	 * Receives the given amount of red coins from the caller of the method.
	 * 
	 * @param amount the amount of red coins
	 */
	@RedPayable @FromContract
	public final void receiveRed(long amount) {}

	/**
	 * Receives the given amount of red coins from the caller of the method.
	 * 
	 * @param amount the amount of red coins
	 */
	@RedPayable @FromContract
	public final void receiveRed(BigInteger amount) {}
}