Package alexiil.mc.lib.attributes.fluid.amount

Class BigFluidAmount

java.lang.Object

alexiil.mc.lib.attributes.fluid.amount.BigFluidAmount

All Implemented Interfaces:

java.lang.Comparable<BigFluidAmount>

public final class BigFluidAmount
extends java.lang.Object

Exact version of FluidAmount. This is generally intended for calculations if the end result should fit into a FluidAmount, but the intermediate steps might not.

Field Summary

Fields

Modifier and Type	Field	Description
static BigFluidAmount	BOTTLE
static BigFluidAmount	BUCKET
java.math.BigInteger	denominator	Always greater than 0.
static BigFluidAmount	NEGATIVE_ONE
java.math.BigInteger	numerator
static BigFluidAmount	ONE
java.math.BigInteger	whole
static BigFluidAmount	ZERO

Constructor Summary

Constructors

Constructor	Description
BigFluidAmount(FluidAmount from)

Method Summary

Modifier and Type	Method	Description
BigFluidAmount	add(long by)
BigFluidAmount	add(BigFluidAmount by)
BigFluidAmount	add(FluidAmount by)
BigFluidAmount	asBigInt()
double	asInexactDouble()
FluidAmount	asLongIntExact()
FluidAmount	asLongIntRounded()	Converts this into a normal long-based FluidAmount.
FluidAmount	asLongIntRounded(java.math.RoundingMode rounding)	Converts this into a normal long-based FluidAmount.
FluidAmount	asLongIntSaturated()	Converts this into a normal long-based FluidAmount.
int	compareTo(BigFluidAmount o)	Null is treated as zero
BigFluidAmount	div(long by)
BigFluidAmount	div(BigFluidAmount by)
BigFluidAmount	div(FluidAmount by)
boolean	equals(BigFluidAmount other)
boolean	equals(java.lang.Object obj)
boolean	fitsInLongInt()
BigFluidAmount	gcd(BigFluidAmount other)
BigFluidAmount	gcd(FluidAmount other)
BigFluidAmount	getDivisor()
int	hashCode()
boolean	isGreaterThan(BigFluidAmount other)	Null is treated as zero
boolean	isGreaterThanOrEqual(BigFluidAmount other)	Null is treated as zero
boolean	isLessThan(BigFluidAmount other)	Null is treated as zero
boolean	isLessThanOrEqual(BigFluidAmount other)	Null is treated as zero
boolean	isNegative()
boolean	isPositive()
boolean	isZero()
BigFluidAmount	lcm(BigFluidAmount other)
BigFluidAmount	max(BigFluidAmount other)
BigFluidAmount	min(BigFluidAmount other)
BigFluidAmount	mul(long by)
BigFluidAmount	mul(BigFluidAmount by)
BigFluidAmount	mul(FluidAmount by)
BigFluidAmount	negate()
static BigFluidAmount	of(java.math.BigInteger numerator, java.math.BigInteger denominator)	Creates a new FluidAmount with the given values.
static BigFluidAmount	of(java.math.BigInteger whole, java.math.BigInteger numerator, java.math.BigInteger denominator)	Creates a new FluidAmount with the given values.
BigFluidAmount	reciprocal()
int	sign()
BigFluidAmount	sub(long by)
BigFluidAmount	sub(BigFluidAmount by)
BigFluidAmount	sub(FluidAmount by)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ZERO

public static final BigFluidAmount ZERO

ONE

public static final BigFluidAmount ONE

NEGATIVE_ONE

public static final BigFluidAmount NEGATIVE_ONE

BUCKET

public static final BigFluidAmount BUCKET

BOTTLE

public static final BigFluidAmount BOTTLE

whole

public final java.math.BigInteger whole

numerator

public final java.math.BigInteger numerator

denominator

public final java.math.BigInteger denominator

Always greater than 0.

Constructor Details

BigFluidAmount

public BigFluidAmount(FluidAmount from)

Method Details

of

public static BigFluidAmount of(java.math.BigInteger numerator, java.math.BigInteger denominator)

Creates a new FluidAmount with the given values. This will reduce the fraction into it's simplest form.

of

public static BigFluidAmount of(java.math.BigInteger whole, java.math.BigInteger numerator, java.math.BigInteger denominator)

Creates a new FluidAmount with the given values. This will reduce the fraction into it's simplest form.

Throws:

java.lang.IllegalArgumentException - if either whole or numerator are negative, or if denominator is less than or equal to 0.

isZero

public boolean isZero()

isNegative

public boolean isNegative()

isPositive

public boolean isPositive()

sign

public int sign()

Returns:

The sign: Either -1 if this is negative, +1 if this is positive, or 0 if this is zero.

getDivisor

public BigFluidAmount getDivisor()

Returns:

The denominator represented in a new fraction, as 1/this.denominator.

lcm

public BigFluidAmount lcm(BigFluidAmount other)

negate

public BigFluidAmount negate()

reciprocal

public BigFluidAmount reciprocal()

Returns:

This fraction, but inverted. (With the numerator and denominator swapped).

asLongIntExact

public FluidAmount asLongIntExact()

Throws:

java.lang.ArithmeticException - if the given values don't fit in a FluidAmount

fitsInLongInt

public boolean fitsInLongInt()

Returns:

True if asLongIntExact() will not throw an arithmetic exception.

asLongIntSaturated

public FluidAmount asLongIntSaturated()

Converts this into a normal long-based FluidAmount. If this is too big to fit then this returns either FluidAmount.MIN_BUCKETS or FluidAmount.MAX_BUCKETS according this the sign().

asLongIntRounded

public FluidAmount asLongIntRounded()

Converts this into a normal long-based FluidAmount.

If whole is too large to fit in a long then either FluidAmount.MIN_BUCKETS or FluidAmount.MAX_BUCKETS is returned (depending on this sign).

Otherwise this is approximately rounded to a valid value.

asLongIntRounded

public FluidAmount asLongIntRounded(java.math.RoundingMode rounding)

Converts this into a normal long-based FluidAmount.

If whole is too large to fit in a long then either FluidAmount.MIN_BUCKETS or FluidAmount.MAX_BUCKETS is returned (depending on this sign).

Otherwise this is approximately rounded to a valid value.

asBigInt

public BigFluidAmount asBigInt()

add

public BigFluidAmount add(long by)

add

public BigFluidAmount add(@Nullable BigFluidAmount by)

add

public BigFluidAmount add(@Nullable FluidAmount by)

sub

public BigFluidAmount sub(long by)

sub

public BigFluidAmount sub(@Nullable BigFluidAmount by)

sub

public BigFluidAmount sub(@Nullable FluidAmount by)

mul

public BigFluidAmount mul(long by)

mul

public BigFluidAmount mul(BigFluidAmount by)

mul

public BigFluidAmount mul(FluidAmount by)

div

public BigFluidAmount div(long by)

div

public BigFluidAmount div(BigFluidAmount by)

div

public BigFluidAmount div(FluidAmount by)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(BigFluidAmount other)

Returns:

True if the number that this FluidAmount represents is equal to the number that the given FluidAmount represents.

compareTo

public int compareTo(BigFluidAmount o)

Null is treated as zero

Specified by:

compareTo in interface java.lang.Comparable<BigFluidAmount>

asInexactDouble

public double asInexactDouble()

isGreaterThan

public boolean isGreaterThan(@Nullable BigFluidAmount other)

Null is treated as zero

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(@Nullable BigFluidAmount other)

Null is treated as zero

isLessThan

public boolean isLessThan(@Nullable BigFluidAmount other)

Null is treated as zero

isLessThanOrEqual

public boolean isLessThanOrEqual(@Nullable BigFluidAmount other)

Null is treated as zero

gcd

public BigFluidAmount gcd(FluidAmount other)

gcd

public BigFluidAmount gcd(BigFluidAmount other)

min

public BigFluidAmount min(BigFluidAmount other)

Returns:

The smaller of this value and then given value.

max

public BigFluidAmount max(BigFluidAmount other)

Returns:

The greater of this value and then given value.