Class Double2ObjectLinkedOpenHashMap<V>
- All Implemented Interfaces:
Double2ObjectFunction<V>
,Double2ObjectMap<V>
,Double2ObjectSortedMap<V>
,Function<Double,
,V> Hash
,Serializable
,Cloneable
,DoubleFunction<V>
,Function<Double,
,V> Map<Double,
,V> SequencedMap<Double,
,V> SortedMap<Double,
V>
Instances of this class use a hash table to represent a map. The table is filled up to a specified load factor, and then doubled in size to accommodate new entries. If the table is emptied below one fourth of the load factor, it is halved in size; however, the table is never reduced to a size smaller than that at creation time: this approach makes it possible to create maps with a large capacity in which insertions and deletions do not cause immediately rehashing. Moreover, halving is not performed when deleting entries from an iterator, as it would interfere with the iteration process.
Note that clear()
does not modify the hash table size. Rather, a family of
trimming methods lets you control the size of the table; this is
particularly useful if you reuse instances of this class.
Entries returned by the type-specific Double2ObjectMap.entrySet()
method implement the suitable
type-specific Pair
interface; only values are mutable.
Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the map does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.
This class implements the interface of a sorted map, so to allow easy access of the iteration
order: for instance, you can get the first key in iteration order with firstKey()
without
having to create an iterator; however, this class partially violates the
SortedMap
contract because all submap methods throw an exception and
comparator()
returns always null
.
Additional methods, such as getAndMoveToFirst()
, make it easy to use instances of this
class as a cache (e.g., with LRU policy).
The iterators provided by the views of this class using are type-specific
list iterators, and can be started at any element which
is a key of the map, or a NoSuchElementException
exception will be thrown. If,
however, the provided element is not the first or last key in the map, the first access to the
list index will require linear time, as in the worst case the entire key set must be scanned in
iteration order to retrieve the positional index of the starting key. If you use just the methods
of a type-specific BidirectionalIterator
, however, all operations
will be performed in constant time.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectMap
AbstractDouble2ObjectMap.BasicEntry<V>, AbstractDouble2ObjectMap.BasicEntrySet<V>
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectMap
Double2ObjectMap.Entry<V>, Double2ObjectMap.FastEntrySet<V>
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectSortedMap
Double2ObjectSortedMap.FastSortedEntrySet<V>
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
Hash.Strategy<K>
-
Field Summary
Fields inherited from interface it.unimi.dsi.fastutil.Hash
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
-
Constructor Summary
ConstructorDescriptionCreates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor.Double2ObjectLinkedOpenHashMap
(double[] k, V[] v) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.Double2ObjectLinkedOpenHashMap
(double[] k, V[] v, float f) Creates a new hash map using the elements of two parallel arrays.Double2ObjectLinkedOpenHashMap
(int expected) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.Double2ObjectLinkedOpenHashMap
(int expected, float f) Creates a new hash map.Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.Double2ObjectLinkedOpenHashMap
(Double2ObjectMap<V> m, float f) Creates a new hash map copying a given type-specific one.Double2ObjectLinkedOpenHashMap
(Map<? extends Double, ? extends V> m) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.Double2ObjectLinkedOpenHashMap
(Map<? extends Double, ? extends V> m, float f) Creates a new hash map copying a given one. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all of the mappings from this map (optional operation).clone()
Returns a deep copy of this map.Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.compute
(double k, BiFunction<? super Double, ? super V, ? extends V> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).computeIfAbsent
(double key, Double2ObjectFunction<? extends V> mappingFunction) If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.computeIfAbsent
(double k, DoubleFunction<? extends V> mappingFunction) If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.computeIfPresent
(double k, BiFunction<? super Double, ? super V, ? extends V> remappingFunction) If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.boolean
containsKey
(double k) Returns true if this function contains a mapping for the specified key.boolean
Returns a type-specific sorted-set view of the mappings contained in this map.void
ensureCapacity
(int capacity) Ensures that this map can hold a certain number of keys without rehashing.double
Returns the first key of this map in iteration order.get
(double k) Returns the value to which the given key is mapped.getAndMoveToFirst
(double k) Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.getAndMoveToLast
(double k) Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.getOrDefault
(double k, V defaultValue) Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.int
hashCode()
Returns a hash code for this map.headMap
(double to) Returns a view of the portion of this sorted map whose keys are strictly less thantoKey
.boolean
isEmpty()
keySet()
Returns a type-specific-set view of the keys of this map.double
Returns the last key of this map in iteration order.If the specified key is not already associated with a value, associates it with the givenvalue
.Adds a pair to the map (optional operation).void
putAndMoveToFirst
(double k, V v) Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.putAndMoveToLast
(double k, V v) Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.putIfAbsent
(double k, V v) If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.remove
(double k) Removes the mapping with the given key (optional operation).boolean
Removes the entry for the specified key only if it is currently mapped to the specified value.Removes the mapping associated with the first key in iteration order.Removes the mapping associated with the last key in iteration order.Replaces the entry for the specified key only if it is currently mapped to some value.boolean
Replaces the entry for the specified key only if currently mapped to the specified value.int
size()
Returns the number of key/value mappings in this map.subMap
(double from, double to) Returns a view of the portion of this sorted map whose keys range fromfromKey
, inclusive, totoKey
, exclusive.tailMap
(double from) Returns a view of the portion of this sorted map whose keys are greater than or equal tofromKey
.boolean
trim()
Rehashes the map, making the table as small as possible.boolean
trim
(int n) Rehashes this map if the table is too large.values()
Returns a type-specific-set view of the values of this map.Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectMap
equals, toString
Methods inherited from class it.unimi.dsi.fastutil.doubles.AbstractDouble2ObjectFunction
defaultReturnValue, defaultReturnValue
Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectFunction
andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, apply, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort
Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectMap
computeIfAbsentPartial, containsKey, defaultReturnValue, defaultReturnValue, forEach, get, getOrDefault, put, remove
Methods inherited from interface it.unimi.dsi.fastutil.doubles.Double2ObjectSortedMap
entrySet, firstKey, headMap, lastKey, subMap, tailMap
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, get, getOrDefault, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll
Methods inherited from interface java.util.SequencedMap
firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues
-
Constructor Details
-
Double2ObjectLinkedOpenHashMap
public Double2ObjectLinkedOpenHashMap(int expected, float f) Creates a new hash map.The actual table size will be the least power of two greater than
expected
/f
.- Parameters:
expected
- the expected number of elements in the hash map.f
- the load factor.
-
Double2ObjectLinkedOpenHashMap
public Double2ObjectLinkedOpenHashMap(int expected) Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor.- Parameters:
expected
- the expected number of elements in the hash map.
-
Double2ObjectLinkedOpenHashMap
public Double2ObjectLinkedOpenHashMap()Creates a new hash map with initial expectedHash.DEFAULT_INITIAL_SIZE
entries andHash.DEFAULT_LOAD_FACTOR
as load factor. -
Double2ObjectLinkedOpenHashMap
Creates a new hash map copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.f
- the load factor.
-
Double2ObjectLinkedOpenHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.- Parameters:
m
- aMap
to be copied into the new hash map.
-
Double2ObjectLinkedOpenHashMap
Creates a new hash map copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.f
- the load factor.
-
Double2ObjectLinkedOpenHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.- Parameters:
m
- a type-specific map to be copied into the new hash map.
-
Double2ObjectLinkedOpenHashMap
Creates a new hash map using the elements of two parallel arrays.- Parameters:
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.f
- the load factor.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
Double2ObjectLinkedOpenHashMap
Creates a new hash map withHash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.- Parameters:
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.- Throws:
IllegalArgumentException
- ifk
andv
have different lengths.
-
-
Method Details
-
ensureCapacity
public void ensureCapacity(int capacity) Ensures that this map can hold a certain number of keys without rehashing.- Parameters:
capacity
- a number of keys; there will be no rehashing unless the map size exceeds this number.
-
putAll
Description copied from class:AbstractDouble2ObjectMap
-
put
Description copied from interface:Double2ObjectFunction
Adds a pair to the map (optional operation).- Specified by:
put
in interfaceDouble2ObjectFunction<V>
- Parameters:
k
- the key.v
- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
-
remove
Description copied from interface:Double2ObjectFunction
Removes the mapping with the given key (optional operation).- Specified by:
remove
in interfaceDouble2ObjectFunction<V>
- Parameters:
k
- the key.- Returns:
- the old value, or the default return value if no value was present for the given key.
- See Also:
-
removeFirst
Removes the mapping associated with the first key in iteration order.- Returns:
- the value previously associated with the first key in iteration order.
- Throws:
NoSuchElementException
- is this map is empty.
-
removeLast
Removes the mapping associated with the last key in iteration order.- Returns:
- the value previously associated with the last key in iteration order.
- Throws:
NoSuchElementException
- is this map is empty.
-
getAndMoveToFirst
Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order.- Parameters:
k
- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
-
getAndMoveToLast
Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order.- Parameters:
k
- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
-
putAndMoveToFirst
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order.- Parameters:
k
- the key.v
- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
-
putAndMoveToLast
Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order.- Parameters:
k
- the key.v
- the value.- Returns:
- the old value, or the default return value if no value was present for the given key.
-
get
Description copied from interface:Double2ObjectFunction
Returns the value to which the given key is mapped.- Specified by:
get
in interfaceDouble2ObjectFunction<V>
- Parameters:
k
- the key.- Returns:
- the corresponding value, or the default return value if no value was present for the given key.
- See Also:
-
containsKey
public boolean containsKey(double k) Description copied from class:AbstractDouble2ObjectMap
Returns true if this function contains a mapping for the specified key.- Specified by:
containsKey
in interfaceDouble2ObjectFunction<V>
- Specified by:
containsKey
in interfaceDouble2ObjectMap<V>
- Overrides:
containsKey
in classAbstractDouble2ObjectMap<V>
- Parameters:
k
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
-
containsValue
Description copied from class:AbstractDouble2ObjectMap
- Specified by:
containsValue
in interfaceMap<Double,
V> - Overrides:
containsValue
in classAbstractDouble2ObjectMap<V>
-
getOrDefault
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.- Specified by:
getOrDefault
in interfaceDouble2ObjectFunction<V>
- Specified by:
getOrDefault
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- the key.defaultValue
- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValue
if this map contains no mapping for the key. - See Also:
-
putIfAbsent
If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.- Specified by:
putIfAbsent
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is to be associated.v
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- See Also:
-
remove
Removes the entry for the specified key only if it is currently mapped to the specified value.- Specified by:
remove
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is associated.v
- value expected to be associated with the specified key.- Returns:
true
if the value was removed.- See Also:
-
replace
Replaces the entry for the specified key only if currently mapped to the specified value.- Specified by:
replace
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is associated.oldValue
- value expected to be associated with the specified key.v
- value to be associated with the specified key.- Returns:
true
if the value was replaced.- See Also:
-
replace
Replaces the entry for the specified key only if it is currently mapped to some value.- Specified by:
replace
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is associated.v
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- See Also:
-
computeIfAbsent
If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the
mappingFunction
cannot returnnull
. If such a behavior is needed, please use the corresponding nullable version.- Specified by:
computeIfAbsent
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- See Also:
-
computeIfAbsent
If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.This version of computeIfAbsent() uses a type-specific version of
fastutil
'sFunction
. SinceFunction
has acontainsKey()
method, it is possible to avoid adding a key by havingcontainsKey()
returnfalse
for that key.- Specified by:
computeIfAbsent
in interfaceDouble2ObjectMap<V>
- Parameters:
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- See Also:
-
computeIfPresent
public V computeIfPresent(double k, BiFunction<? super Double, ? super V, ? extends V> remappingFunction) If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.- Specified by:
computeIfPresent
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- See Also:
-
compute
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).If the function returns
null
, the mapping is removed (or remains absent if initially absent). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.- Specified by:
compute
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- See Also:
-
merge
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result isnull
.- Specified by:
merge
in interfaceDouble2ObjectMap<V>
- Parameters:
k
- key with which the resulting value is to be associated.v
- the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.- Returns:
- the new value associated with the specified key, or the default return value if no value is associated with the key.
- See Also:
-
clear
public void clear()Description copied from interface:Double2ObjectMap
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns. -
size
public int size()Description copied from interface:Double2ObjectMap
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
. -
isEmpty
public boolean isEmpty() -
firstDoubleKey
public double firstDoubleKey()Returns the first key of this map in iteration order.- Specified by:
firstDoubleKey
in interfaceDouble2ObjectSortedMap<V>
- Returns:
- the first key in iteration order.
- See Also:
-
lastDoubleKey
public double lastDoubleKey()Returns the last key of this map in iteration order.- Specified by:
lastDoubleKey
in interfaceDouble2ObjectSortedMap<V>
- Returns:
- the last key in iteration order.
- See Also:
-
tailMap
Returns a view of the portion of this sorted map whose keys are greater than or equal tofromKey
.- Specified by:
tailMap
in interfaceDouble2ObjectSortedMap<V>
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
headMap
Returns a view of the portion of this sorted map whose keys are strictly less thantoKey
.- Specified by:
headMap
in interfaceDouble2ObjectSortedMap<V>
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
subMap
Returns a view of the portion of this sorted map whose keys range fromfromKey
, inclusive, totoKey
, exclusive.- Specified by:
subMap
in interfaceDouble2ObjectSortedMap<V>
- See Also:
- Implementation Specification:
- This implementation just throws an
UnsupportedOperationException
.
-
comparator
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering.- Specified by:
comparator
in interfaceDouble2ObjectSortedMap<V>
- Specified by:
comparator
in interfaceSortedMap<Double,
V> - See Also:
- Implementation Specification:
- This implementation just returns
null
.
-
double2ObjectEntrySet
Description copied from interface:Double2ObjectSortedMap
Returns a type-specific sorted-set view of the mappings contained in this map.- Specified by:
double2ObjectEntrySet
in interfaceDouble2ObjectMap<V>
- Specified by:
double2ObjectEntrySet
in interfaceDouble2ObjectSortedMap<V>
- Returns:
- a type-specific sorted-set view of the mappings contained in this map.
- See Also:
-
keySet
Description copied from class:AbstractDouble2ObjectSortedMap
Returns a type-specific-set view of the keys of this map.The view is backed by the set returned by
Map.entrySet()
. Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.The view is backed by the sorted set returned by
Map.entrySet()
. Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.- Specified by:
keySet
in interfaceDouble2ObjectMap<V>
- Specified by:
keySet
in interfaceDouble2ObjectSortedMap<V>
- Specified by:
keySet
in interfaceMap<Double,
V> - Specified by:
keySet
in interfaceSortedMap<Double,
V> - Overrides:
keySet
in classAbstractDouble2ObjectSortedMap<V>
- Returns:
- a sorted set view of the keys of this map; it may be safely cast to a type-specific interface.
- See Also:
-
values
Description copied from class:AbstractDouble2ObjectSortedMap
Returns a type-specific-set view of the values of this map.The view is backed by the set returned by
Map.entrySet()
. Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.The view is backed by the sorted set returned by
Map.entrySet()
. Note that no attempt is made at caching the result of this method, as this would require adding some attributes that lightweight implementations would not need. Subclasses may easily override this policy by calling this method and caching the result, but implementors are encouraged to write more efficient ad-hoc implementations.- Specified by:
values
in interfaceDouble2ObjectMap<V>
- Specified by:
values
in interfaceDouble2ObjectSortedMap<V>
- Specified by:
values
in interfaceMap<Double,
V> - Specified by:
values
in interfaceSortedMap<Double,
V> - Overrides:
values
in classAbstractDouble2ObjectSortedMap<V>
- Returns:
- a type-specific collection view of the values contained in this map.
- See Also:
-
trim
public boolean trim()Rehashes the map, making the table as small as possible.This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.
If the table size is already the minimum possible, this method does nothing.
- Returns:
- true if there was enough memory to trim the map.
- See Also:
-
trim
public boolean trim(int n) Rehashes this map if the table is too large.Let N be the smallest table size that can hold
max(n,
entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this map in a table of size N.size()
)This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.
- Parameters:
n
- the threshold for the trimming.- Returns:
- true if there was enough memory to trim the map.
- See Also:
-
clone
Returns a deep copy of this map.This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.
- Returns:
- a deep copy of this map.
-
hashCode
public int hashCode()Returns a hash code for this map. This method overrides the generic method provided by the superclass. Sinceequals()
is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.
-