Fraction (sellcom-java 1.6.0)

java.lang.Object
- java.lang.Number
- - org.sellcom.core.math.Fraction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Fraction>
```
public class Fraction
extends java.lang.Number
implements java.lang.Comparable<Fraction>
```
Fraction of two ints.
The value of the fraction is always kept reduced to the lowest possible terms.

Since:

1.6

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static Fraction`	`ONE`	Fraction of `1/1`.
`static Fraction`	`ONE_HALF`	Fraction of `1/2`.
`static Fraction`	`ONE_QUARTER`	Fraction of `1/4`.
`static Fraction`	`ONE_THIRD`	Fraction of `1/3`.
`static Fraction`	`THREE_QUARTERS`	Fraction of `3/4`.
`static Fraction`	`TWO_THIRDS`	Fraction of `2/3`.
`static Fraction`	`ZERO`	Fraction of `0/1`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Fraction`	`abs()`	Returns the absolute value of this fraction.
`Fraction`	`add(int value)`	Returns the sum of this fraction and the given number.
`Fraction`	`add(Fraction other)`	Returns the sum of this fraction and the given fraction.
`int`	`compareTo(Fraction other)`
`Fraction`	`divide(int value)`	Returns the quotient of this fraction and the given number.
`Fraction`	`divide(Fraction other)`	Returns the quotient of this fraction and the given fraction.
`double`	`doubleValue()`
`boolean`	`equals(java.lang.Object other)`
`float`	`floatValue()`
`int`	`getDenominator()`	Returns the denominator of this fraction.
`int`	`getNumerator()`	Returns the numerator of this fraction.
`int`	`hashCode()`
`int`	`intValue()`
`int`	`intValueExact()`	Returns the `int` value of this fraction.
`boolean`	`isInteger()`	Checks whether the value of this fraction is an integer.
`long`	`longValue()`
`long`	`longValueExact()`	Returns the `long` value of this fraction.
`Fraction`	`multiply(int value)`	Returns the product of this fraction and the given number.
`Fraction`	`multiply(Fraction other)`	Returns the product of this fraction and the given fraction.
`Fraction`	`negate()`	Returns the opposite of this fraction.
`static Fraction`	`parse(java.lang.String text)`	Returns a fraction obtained from the given text string.
`Fraction`	`pow(int exponent)`	Returns this fraction raised to the power of the given exponent.
`Fraction`	`reciprocal()`	Return the reciprocal of this fraction.
`int`	`round(java.math.RoundingMode roundingMode)`	Returns the integer value nearest to the value of this fraction.
`int`	`signum()`	Returns the signum of this value.
`Fraction`	`subtract(int value)`	Returns the difference of this fraction and the given number.
`Fraction`	`subtract(Fraction other)`	Returns the difference of this fraction and the given fraction.
`java.math.BigDecimal`	`toBigDecimal()`	Returns the `BigDecimal` value of this fraction.
`java.math.BigDecimal`	`toBigDecimal(int scale, java.math.RoundingMode roundingMode)`	Returns the `BigDecimal` value of this fraction.
`java.lang.String`	`toString()`
`static Fraction`	`valueOf(int value)`	Returns a fraction with the given value.
`static Fraction`	`valueOf(int numerator, int denominator)`	Returns a fraction with the given numerator and denominator.

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ONE
```
public static final Fraction ONE
```
    Fraction of 1/1.
    
    Since:
    
    1.6
  - ONE_HALF
```
public static final Fraction ONE_HALF
```
    Fraction of 1/2.
    
    Since:
    
    1.6
  - ONE_QUARTER
```
public static final Fraction ONE_QUARTER
```
    Fraction of 1/4.
    
    Since:
    
    1.6
  - ONE_THIRD
```
public static final Fraction ONE_THIRD
```
    Fraction of 1/3.
    
    Since:
    
    1.6
  - THREE_QUARTERS
```
public static final Fraction THREE_QUARTERS
```
    Fraction of 3/4.
    
    Since:
    
    1.6
  - TWO_THIRDS
```
public static final Fraction TWO_THIRDS
```
    Fraction of 2/3.
    
    Since:
    
    1.6
  - ZERO
```
public static final Fraction ZERO
```
    Fraction of 0/1.
    
    Since:
    
    1.6
- Method Detail
  - abs
```
public Fraction abs()
```
    Returns the absolute value of this fraction.
    
    Throws:
    
    java.lang.ArithmeticException - if numerator is equal to Integer.MIN_VALUE
    
    Since:
    
    1.6
  - add
```
public Fraction add(Fraction other)
```
    Returns the sum of this fraction and the given fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if other is null
    
    Since:
    
    1.6
  - add
```
public Fraction add(int value)
```
    Returns the sum of this fraction and the given number.
    
    Since:
    
    1.6
  - compareTo
```
public int compareTo(Fraction other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Fraction>
  - divide
```
public Fraction divide(Fraction other)
```
    Returns the quotient of this fraction and the given fraction.
    
    Throws:
    
    java.lang.ArithmeticException - if other is equal to 0
    
    Since:
    
    1.6
  - divide
```
public Fraction divide(int value)
```
    Returns the quotient of this fraction and the given number.
    
    Throws:
    
    java.lang.ArithmeticException - if value is equal to 0
    
    Since:
    
    1.6
  - doubleValue
```
public double doubleValue()
```
    Specified by:
    
    doubleValue in class java.lang.Number
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - floatValue
```
public float floatValue()
```
    Specified by:
    
    floatValue in class java.lang.Number
  - getDenominator
```
public int getDenominator()
```
    Returns the denominator of this fraction.
    
    Since:
    
    1.6
  - getNumerator
```
public int getNumerator()
```
    Returns the numerator of this fraction.
    
    Since:
    
    1.6
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - intValue
```
public int intValue()
```
    Specified by:
    
    intValue in class java.lang.Number
  - isInteger
```
public boolean isInteger()
```
    Checks whether the value of this fraction is an integer.
    
    Since:
    
    1.6
  - intValueExact
```
public int intValueExact()
```
    Returns the int value of this fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value of this fraction does not exactly fit an int
    
    Since:
    
    1.6
  - longValue
```
public long longValue()
```
    Specified by:
    
    longValue in class java.lang.Number
  - longValueExact
```
public long longValueExact()
```
    Returns the long value of this fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value of this fraction does not exactly fit a long
    
    Since:
    
    1.6
  - multiply
```
public Fraction multiply(Fraction other)
```
    Returns the product of this fraction and the given fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if other is null
    
    Since:
    
    1.6
  - multiply
```
public Fraction multiply(int value)
```
    Returns the product of this fraction and the given number.
    
    Since:
    
    1.6
  - negate
```
public Fraction negate()
```
    Returns the opposite of this fraction.
    
    Throws:
    
    java.lang.ArithmeticException - if numerator is equal to Integer.MIN_VALUE
    
    Since:
    
    1.6
  - parse
```
public static Fraction parse(java.lang.String text)
```
    Returns a fraction obtained from the given text string.
    
    Throws:
    
    java.lang.IllegalArgumentException - if text is null
    
    java.lang.NumberFormatException - if text is not a valid fraction
    
    Since:
    
    1.6
  - pow
```
public Fraction pow(int exponent)
```
    Returns this fraction raised to the power of the given exponent.
    
    Since:
    
    1.6
  - reciprocal
```
public Fraction reciprocal()
```
    Return the reciprocal of this fraction.
    
    Throws:
    
    java.lang.ArithmeticException - if the value of this fraction is equal to 0
    
    Since:
    
    1.6
  - round
```
public int round(java.math.RoundingMode roundingMode)
```
    Returns the integer value nearest to the value of this fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if roundingMode is null
    
    Since:
    
    1.6
  - signum
```
public int signum()
```
    Returns the signum of this value.
    
    Since:
    
    1.6
  - subtract
```
public Fraction subtract(Fraction other)
```
    Returns the difference of this fraction and the given fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if other is null
    
    Since:
    
    1.6
  - subtract
```
public Fraction subtract(int value)
```
    Returns the difference of this fraction and the given number.
    
    Since:
    
    1.6
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal()
```
    Returns the BigDecimal value of this fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value of this fraction does not have a terminating decimal expansion
    
    Since:
    
    1.6
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal(int scale,
                                         java.math.RoundingMode roundingMode)
```
    Returns the BigDecimal value of this fraction.
    
    Throws:
    
    java.lang.IllegalArgumentException - if roundingMode is null
    
    Since:
    
    1.6
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - valueOf
```
public static Fraction valueOf(int value)
```
    Returns a fraction with the given value.
    
    Since:
    
    1.6
  - valueOf
```
public static Fraction valueOf(int numerator,
                               int denominator)
```
    Returns a fraction with the given numerator and denominator.
    
    Throws:
    
    java.lang.IllegalArgumentException - if denominator is 0
    
    Since:
    
    1.6

Class Fraction

Field Summary

Method Summary

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

ONE

ONE_HALF

ONE_QUARTER

ONE_THIRD

THREE_QUARTERS

TWO_THIRDS

ZERO

Method Detail

abs

add

add

compareTo

divide

divide

doubleValue

equals

floatValue

getDenominator

getNumerator

hashCode

intValue

isInteger

intValueExact

longValue

longValueExact

multiply

multiply

negate

parse

pow

reciprocal

round

signum

subtract

subtract

toBigDecimal

toBigDecimal

toString

valueOf

valueOf