com.yandex.metrica.ecommerce

Class ECommerceAmount

java.lang.Object

com.yandex.metrica.ecommerce.ECommerceAmount

public class ECommerceAmount
extends java.lang.Object

Describes an amount of something - number and unit.

Constructor Summary

Constructors

Constructor and Description
ECommerceAmount(java.math.BigDecimal amount, java.lang.String unit) Creates an amount with BigDecimal value.
ECommerceAmount(double amount, java.lang.String unit) Creates an amount with double value.
ECommerceAmount(long amountMicros, java.lang.String unit) Creates an amount with its value in micros.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount()
java.lang.String	getUnit()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ECommerceAmount

public ECommerceAmount(long amountMicros,
                       @NonNull
                       java.lang.String unit)

Creates an amount with its value in micros.

Parameters:

amountMicros - Amount value in micros (actual amount multiplied by 10^6).

unit - Amount unit. For example, "USD" "RUB", etc.

See Also:

ECommerceAmount(double, String), ECommerceAmount(BigDecimal, String)

ECommerceAmount

public ECommerceAmount(double amount,
                       @NonNull
                       java.lang.String unit)

Creates an amount with double value.

Parameters:

amount - Amount value as double. Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY and Double.NaN will be treated as 0.

unit - Amount unit. For example, "USD", "RUB", etc.

See Also:

ECommerceAmount(long, String), *

ECommerceAmount

public ECommerceAmount(@NonNull
                       java.math.BigDecimal amount,
                       @NonNull
                       java.lang.String unit)

Creates an amount with BigDecimal value.

Parameters:

amount - Amount value as BigDecimal.

unit - Amount unit. For example, "USD", "RUB", etc.

See Also:

ECommerceAmount(long, String), *

Method Detail

getAmount

@NonNull
public java.math.BigDecimal getAmount()

Returns:

decimal amount

See Also:

ECommerceAmount(double, String), ECommerceAmount(long, String), ECommerceAmount(java.math.BigDecimal, String)

getUnit

@NonNull
public java.lang.String getUnit()

Returns:

unit

See Also:

ECommerceAmount(double, String), ECommerceAmount(long, String), ECommerceAmount(java.math.BigDecimal, String)

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object