Package eu.simuline.util

Class CollectionsExt.ImmutableMultiplicity

java.lang.Object

eu.simuline.util.CollectionsExt.ImmutableMultiplicity

All Implemented Interfaces:

MultiSet.Multiplicity, Comparable<MultiSet.Multiplicity>

Enclosing class:

CollectionsExt<E>

private static class CollectionsExt.ImmutableMultiplicity
extends Object
implements MultiSet.Multiplicity

An immutable implementation of the multiplicity interface.

Field Summary

Fields

Modifier and Type	Field	Description
private Set<CollectionsExt.Modification>	mod
private MultiSet.Multiplicity	wrapped

Constructor Summary

Constructors

Constructor	Description
ImmutableMultiplicity(MultiSet.Multiplicity wrapped, Set<CollectionsExt.Modification> mod)

Method Summary

Modifier and Type	Method	Description
int	add(int mult)	Adds the specified multiplicity (which may well be negative) to the wrapped multiplicity which is thus modified.
private Set<CollectionsExt.Modification>	allowedModifications()
int	compareTo(MultiSet.Multiplicity mult)	Defines the natural ordering on natural numbers.
boolean	equals(Object obj)	Returns true if and only if obj is also an instance of Multiplicity and if the wrapped multiplicities coincide.
int	get()	Returns the wrapped multiplicity.
int	hashCode()
int	set(int mult)	Sets the multiplicity wrapped by this object to the specified value.

Methods inherited from class java.lang.Object

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

Field Detail

wrapped

private final MultiSet.Multiplicity wrapped

mod

private final Set<CollectionsExt.Modification> mod

Constructor Detail

ImmutableMultiplicity

ImmutableMultiplicity(MultiSet.Multiplicity wrapped,
                      Set<CollectionsExt.Modification> mod)

Method Detail

allowedModifications

private Set<CollectionsExt.Modification> allowedModifications()

set

public int set(int mult)

Description copied from interface: MultiSet.Multiplicity

Sets the multiplicity wrapped by this object to the specified value.

Specified by:

set in interface MultiSet.Multiplicity

Parameters:

mult - a strictly positive int value representing the old multiplicity.

add

public int add(int mult)

Description copied from interface: MultiSet.Multiplicity

Adds the specified multiplicity (which may well be negative) to the wrapped multiplicity which is thus modified.

Specified by:

add in interface MultiSet.Multiplicity

Parameters:

mult - an int such that this.mult + mult > 0 holds.

Returns:

the new multiplicity this.mult + mult.

get

public int get()

Description copied from interface: MultiSet.Multiplicity

Returns the wrapped multiplicity.

Specified by:

get in interface MultiSet.Multiplicity

compareTo

public int compareTo(MultiSet.Multiplicity mult)

Description copied from interface: MultiSet.Multiplicity

Defines the natural ordering on natural numbers.

Specified by:

compareTo in interface Comparable<MultiSet.Multiplicity>

Specified by:

compareTo in interface MultiSet.Multiplicity

Parameters:

mult - a Multiplicity which should in fact be another MultiSet.Multiplicity.

Returns:

the difference of the wrapped multiplicities.

equals

public boolean equals(Object obj)

Returns true if and only if obj is also an instance of Multiplicity and if the wrapped multiplicities coincide.

Specified by:

equals in interface MultiSet.Multiplicity

Overrides:

equals in class Object

Parameters:

obj - an Object value which may well be null.

Returns:

a boolean value which indicates whether obj is also an instance of Multiplicity and whether the wrapped multiplicity coincides with this one.

See Also:

compareTo(eu.simuline.util.MultiSet.Multiplicity)

hashCode

public int hashCode()

Overrides:

hashCode in class Object