BasisPoints (OpenGamma Strata Collect)

java.lang.Object
- com.opengamma.strata.collect.BasisPoints

All Implemented Interfaces:

Comparable<BasisPoints>
```
public final class BasisPoints
extends Object
implements Comparable<BasisPoints>
```
A percentage amount, with a maximum of 8 decimal places.
A number has three standard representations in finance:
- decimal form - the form needed for mathematical calculations, as used by most parts of Strata
- percentage - where 1.2% is the same as the decimal 0.012
- basis points - where 125bps is the same as the decimal 0.0125
This class allows the use of basis points form to be explicit.

Field Summary

Fields
Modifier and Type Field and Description

static BasisPoints ZERO
A basis points of zero.

Fields
Modifier and Type	Field and Description
`static BasisPoints`	`ZERO` A basis points of zero.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(BasisPoints other)` Compares this instance to another.
`boolean`	`equals(Object obj)` Checks if this instance equals another.
`static BasisPoints`	`fromDecimalForm(Decimal decimal)` Obtains an instance from mathematical decimal form, where 0.007 will create an instance representing 70bps.
`static BasisPoints`	`fromDecimalForm(double decimal)` Obtains an instance from mathematical decimal form, where 0.007 will create an instance representing 70bps.
`static BasisPoints`	`fromPercentage(Percentage percentage)` Obtains an instance from a percentage, where 0.7% will create an instance representing 70bps.
`int`	`hashCode()` Returns a suitable hash code.
`BasisPoints`	`map(UnaryOperator<Decimal> mapper)` Applies an operation to the value.
`BasisPoints`	`minus(BasisPoints other)` Returns a basis points equal to the this basis points minus the other one.
`static BasisPoints`	`of(Decimal basisPoints)` Obtains an instance from a basis points value.
`static BasisPoints`	`of(double basisPoints)` Obtains an instance from a basis points value.
`static BasisPoints`	`parse(String str)` Parses a percentage.
`BasisPoints`	`plus(BasisPoints other)` Returns a basis points equal to the this basis points plus the other one.
`Decimal`	`toDecimalForm()` Converts this basis points to mathematical decimal form.
`Percentage`	`toPercentage()` Converts this basis points to the equivalent percentage.
`String`	`toString()` Returns the formal string representation, '{value}bps'.
`Decimal`	`valueBasisPoints()` Gets the value in basis points form as a `Decimal`.

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

- Field Detail
  - ZERO
```
public static final BasisPoints ZERO
```
    A basis points of zero.
- Method Detail
  - of
```
public static BasisPoints of(double basisPoints)
```
    Obtains an instance from a basis points value.
    
    Parameters:
    
    basisPoints - the basis points value
    
    Returns:
    
    the basis points object, rounded (HALF_UP) to 8 decimal places
  - of
```
public static BasisPoints of(Decimal basisPoints)
```
    Obtains an instance from a basis points value.
    
    Parameters:
    
    basisPoints - the basis points value
    
    Returns:
    
    the basis points object, rounded (HALF_UP) to 8 decimal places
  - fromDecimalForm
```
public static BasisPoints fromDecimalForm(double decimal)
```
    Obtains an instance from mathematical decimal form, where 0.007 will create an instance representing 70bps.
    
    Parameters:
    
    decimal - the mathematical decimal value
    
    Returns:
    
    the basis points object, rounded (HALF_UP) to 8 decimal places
  - fromDecimalForm
```
public static BasisPoints fromDecimalForm(Decimal decimal)
```
    Obtains an instance from mathematical decimal form, where 0.007 will create an instance representing 70bps.
    
    Parameters:
    
    decimal - the mathematical decimal value
    
    Returns:
    
    the basis points object, rounded (HALF_UP) to 8 decimal places
  - fromPercentage
```
public static BasisPoints fromPercentage(Percentage percentage)
```
    Obtains an instance from a percentage, where 0.7% will create an instance representing 70bps.
    
    Parameters:
    
    percentage - the percentage
    
    Returns:
    
    the basis points object
  - parse
```
public static BasisPoints parse(String str)
```
    Parses a percentage.
    The percentage may be suffixed by 'bps'.
    
    Parameters:
    
    str - the basis points string
    
    Returns:
    
    the basis points object, rounded to 8 decimal places
  - valueBasisPoints
```
public Decimal valueBasisPoints()
```
    Gets the value in basis points form as a Decimal.
    A value of 150bps will return 150.
    
    Returns:
    
    the value in basis points form, with a maximum of 8 decimal places
  - toDecimalForm
```
public Decimal toDecimalForm()
```
    Converts this basis points to mathematical decimal form.
    A value of 150bps will return 0.015.
    
    Returns:
    
    the amount in mathematical decimal form
  - toPercentage
```
public Percentage toPercentage()
```
    Converts this basis points to the equivalent percentage.
    A value of 150bps will return 1.5%.
    
    Returns:
    
    the amount in percentage form
  - plus
```
public BasisPoints plus(BasisPoints other)
```
    Returns a basis points equal to the this basis points plus the other one.
    
    Parameters:
    
    other - the other basis points
    
    Returns:
    
    the resulting basis points
  - minus
```
public BasisPoints minus(BasisPoints other)
```
    Returns a basis points equal to the this basis points minus the other one.
    
    Parameters:
    
    other - the other basis points
    
    Returns:
    
    the resulting basis points
  - map
```
public BasisPoints map(UnaryOperator<Decimal> mapper)
```
    Applies an operation to the value.
    This is generally used to apply a mathematical operation to the value. For example, the operator could multiply the value by a constant, or take the inverse.
```
   abs = base.map(value -> value.abs());
 
```
    Parameters:
    
    mapper - the operator to be applied to the amount
    
    Returns:
    
    a copy of this value with the mapping applied to the original amount
  - compareTo
```
public int compareTo(BasisPoints other)
```
    Compares this instance to another.
    
    Specified by:
    
    compareTo in interface Comparable<BasisPoints>
    
    Parameters:
    
    other - the other instance
    
    Returns:
    
    the comparison result
  - equals
```
public boolean equals(Object obj)
```
    Checks if this instance equals another.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the other instance
    
    Returns:
    
    true if equal
  - hashCode
```
public int hashCode()
```
    Returns a suitable hash code.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code
  - toString
```
public String toString()
```
    Returns the formal string representation, '{value}bps'.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the formal string

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class BasisPoints

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ZERO

Method Detail

of

of

fromDecimalForm

fromDecimalForm

fromPercentage

parse

valueBasisPoints

toDecimalForm

toPercentage

plus

minus

map

compareTo

equals

hashCode

toString