Package org.apache.tuweni.units.ethereum

Class Gas

java.lang.Object

org.apache.tuweni.units.bigints.BaseUInt256Value<Gas>

org.apache.tuweni.units.ethereum.Gas

All Implemented Interfaces:

Comparable<org.apache.tuweni.bytes.Bytes>, org.apache.tuweni.bytes.Bytes, org.apache.tuweni.bytes.Bytes32, UInt256Value<Gas>

public final class Gas
extends BaseUInt256Value<Gas>

A unit measure of Gas as used by the Ethereum VM.

Field Summary

Fields

Modifier and Type	Field	Description
static final Gas	MAX
static final Gas	ZERO

Fields inherited from interface org.apache.tuweni.bytes.Bytes

EMPTY

Fields inherited from interface org.apache.tuweni.bytes.Bytes32

SIZE

Method Summary

Modifier and Type	Method	Description
static Gas	minimum(Gas one, Gas two)	Provides the minimum value between 2 gas objects.
Wei	priceFor(Wei gasPrice)	The price of this amount of gas given the provided price per unit of gas.
boolean	tooHigh()	Returns true if the gas value is past the maximum allowed gas, 2^63 -1
static Gas	valueOf(long value)	Return a Gas containing the specified value.
static Gas	valueOf(BigInteger value)	Return a Gas containing the specified value.
static Gas	valueOf(UInt256 value)	Return a Gas containing the specified value.

Methods inherited from class org.apache.tuweni.units.bigints.BaseUInt256Value

add, add, add, addMod, addMod, addMod, addMod, compareTo, copy, divide, divide, divide, divideCeil, divideCeil, divideCeil, equals, get, hashCode, max, mod, mod, mod0, mod0, multiply, multiply, multiply, multiplyMod, multiplyMod, multiplyMod, multiplyMod, mutableCopy, pow, pow, slice, subtract, subtract, subtract, toBytes, toLong, toMinimalBytes, toString, toUInt256, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tuweni.bytes.Bytes

and, and, appendHexTo, appendTo, appendTo, bitLength, commonPrefix, commonPrefixLength, compareTo, copyTo, copyTo, getInt, getInt, getLong, getLong, hasLeadingZero, hasLeadingZeroByte, isEmpty, isZero, not, numberOfLeadingZeroBytes, numberOfLeadingZeros, numberOfTrailingZeroBytes, or, or, reverse, shiftLeft, shiftRight, slice, toArray, toArray, toArrayUnsafe, toBase64String, toEllipsisHexString, toFastHex, toHexString, toInt, toLong, toQuantityHexString, toShortHexString, toUnprefixedHexString, toUnsignedBigInteger, toUnsignedBigInteger, trimLeadingZeros, trimTrailingZeros, update, xor, xor

Methods inherited from interface org.apache.tuweni.bytes.Bytes32

and, not, or, shiftLeft, shiftRight, size, xor

Methods inherited from interface org.apache.tuweni.units.bigints.UInt256Value

addExact, addExact, addSafe, addSafe, fitsInt, fitsInt, fitsLong, fitsLong, greaterOrEqualThan, greaterThan, intValue, lessOrEqualThan, lessThan, plus, plus, subtractExact, subtractExact, toBigInteger, toBigInteger, toDecimalString, toInt, toSignedBigInteger, toSignedBigInteger

Field Details

ZERO

public static final Gas ZERO

MAX

public static final Gas MAX

Method Details

valueOf

public static Gas valueOf(UInt256 value)

Return a Gas containing the specified value.

Parameters:

value - The value to create a Gas for.

Returns:

A Gas containing the specified value.

Throws:

IllegalArgumentException - If the value is negative.

valueOf

public static Gas valueOf(long value)

Return a Gas containing the specified value.

Parameters:

value - The value to create a Gas for.

Returns:

A Gas containing the specified value.

Throws:

IllegalArgumentException - If the value is negative.

valueOf

public static Gas valueOf(BigInteger value)

Return a Gas containing the specified value.

Parameters:

value - The value to create a Gas for.

Returns:

A Gas containing the specified value.

Throws:

IllegalArgumentException - If the value is negative.

minimum

public static Gas minimum(Gas one,
 Gas two)

Provides the minimum value between 2 gas objects.

Parameters:

one - a gas object

two - another gas object

Returns:

the minimum between the 2 gas objects

priceFor

public Wei priceFor(Wei gasPrice)

The price of this amount of gas given the provided price per unit of gas.

Parameters:

gasPrice - The price per unit of gas.

Returns:

The price of this amount of gas for a per unit of gas price of gasPrice.

tooHigh

public boolean tooHigh()

Returns true if the gas value is past the maximum allowed gas, 2^63 -1

Returns:

true if gas is past allowed maximum