Top Description Fields Constructors Methods
org.javamoney.moneta.function

public Class DefaultMonetarySummaryStatistics

extends Object
implements MonetarySummaryStatistics
Class Inheritance
All Implemented Interfaces
org.javamoney.moneta.function.MonetarySummaryStatistics
Imports
java.util.Objects, javax.money.CurrencyUnit, .MonetaryAmount, org.javamoney.moneta.FastMoney
the default implementations of MonetarySummaryStatistics This implementations cannot do exchange rate
Authors
otaviojava, Anatole Tresch, Werner Keil

Field Summary

Modifier and TypeField and Description
protected MonetaryAmount
average

protected long
count

private final MonetaryAmount
empty

protected MonetaryAmount
max

protected MonetaryAmount
min

protected MonetaryAmount
sum

Constructor Summary

AccessConstructor and Description
protected
DefaultMonetarySummaryStatistics(CurrencyUnit
the target currency, not null.
currencyUnit)

Creates a new instance, targeting the given javax.money.CurrencyUnit.

Method Summary

Modifier and TypeMethod and Description
public void
accept(MonetaryAmount amount)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.accept.

Records another value into the summary information.

public MonetarySummaryStatistics
combine(MonetarySummaryStatistics summaryStatistics)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.combine.

Combines the state of another MonetarySummaryStatistics into this one.

private void
doSummary(MonetaryAmount monetaryAmount)

public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public MonetaryAmount
getAverage()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getAverage.

Get the mean average of all amounts added.

public long
getCount()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getCount.

Get the number of items added to this summary instance.

public CurrencyUnit
getCurrencyUnit()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getCurrencyUnit.

the currency unit used in summary

public MonetaryAmount
getMax()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getMax.

Get the maximal amount found within this summary.

public MonetaryAmount
getMin()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getMin.

Get the minimal amount found within this summary.

public MonetaryAmount
getSum()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getSum.

Get the sum of all amounts within this summary.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private boolean
isEmpty()

public boolean
isExchangeable()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.isExchangeable.

return if is possible do exchange rate or not with the MonetarySummary

public static DefaultMonetarySummaryStatistics
of(CurrencyUnit
the target currency, not null.
currencyUnit)

Creates a new instance, targeting the given javax.money.CurrencyUnit.

private void
setSameMonetary(MonetaryAmount monetary)

public MonetarySummaryStatistics
to(CurrencyUnit unit)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.to.

created the MonetarySummaryStatistics converted to CurrencyUnit

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

averageback to summary
protected MonetaryAmount average
countback to summary
protected long count
emptyback to summary
private final MonetaryAmount empty
maxback to summary
protected MonetaryAmount max
minback to summary
protected MonetaryAmount min
sumback to summary
protected MonetaryAmount sum

Constructor Detail

DefaultMonetarySummaryStatisticsback to summary
protected DefaultMonetarySummaryStatistics(CurrencyUnit currencyUnit)

Creates a new instance, targeting the given javax.money.CurrencyUnit.

Parameters
currencyUnit:CurrencyUnit

the target currency, not null.

Method Detail

acceptback to summary
public void accept(MonetaryAmount amount)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.accept.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.accept.

Records another value into the summary information.

Annotations
@Override
combineback to summary
public MonetarySummaryStatistics combine(MonetarySummaryStatistics summaryStatistics)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.combine.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.combine.

Combines the state of another MonetarySummaryStatistics into this one.

Annotations
@Override
doSummaryback to summary
private void doSummary(MonetaryAmount monetaryAmount)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getAverageback to summary
public MonetaryAmount getAverage()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getAverage.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getAverage.

Get the mean average of all amounts added.

Annotations
@Override
getCountback to summary
public long getCount()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getCount.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getCount.

Get the number of items added to this summary instance.

Annotations
@Override
getCurrencyUnitback to summary
public CurrencyUnit getCurrencyUnit()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getCurrencyUnit.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getCurrencyUnit.

the currency unit used in summary

Annotations
@Override
getMaxback to summary
public MonetaryAmount getMax()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getMax.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getMax.

Get the maximal amount found within this summary.

Annotations
@Override
getMinback to summary
public MonetaryAmount getMin()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getMin.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getMin.

Get the minimal amount found within this summary.

Annotations
@Override
getSumback to summary
public MonetaryAmount getSum()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.getSum.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.getSum.

Get the sum of all amounts within this summary.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
isEmptyback to summary
private boolean isEmpty()
isExchangeableback to summary
public boolean isExchangeable()

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.isExchangeable.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.isExchangeable.

return if is possible do exchange rate or not with the MonetarySummary

Annotations
@Override
ofback to summary
public static DefaultMonetarySummaryStatistics of(CurrencyUnit currencyUnit)

Creates a new instance, targeting the given javax.money.CurrencyUnit.

Parameters
currencyUnit:CurrencyUnit

the target currency, not null.

setSameMonetaryback to summary
private void setSameMonetary(MonetaryAmount monetary)
toback to summary
public MonetarySummaryStatistics to(CurrencyUnit unit)

Implements org.javamoney.moneta.function.MonetarySummaryStatistics.to.

Doc from org.javamoney.moneta.function.MonetarySummaryStatistics.to.

created the MonetarySummaryStatistics converted to CurrencyUnit

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override