XStream Core 1.4.20 · com.thoughtworks.xstream.core.util.PresortedMap

Modifier and Type	Class and Description
private static class	PresortedMap.ArraySet
private static class	PresortedMap.ArraySetComparator

Modifier and Type	Field and Description
private final Comparator<T>	comparator
private final PresortedMap.ArraySet	set

Access	Constructor and Description
public	PresortedMap()
public	PresortedMap(Comparator<T> comparator)
private	PresortedMap(Comparator<T> comparator, PresortedMap.ArraySet set)

Method Summary

Modifier and Type	Method and Description
public void	clear() Implements java.util.Map.clear. Removes all of the mappings from this map (optional operation).
public Comparator<T>	comparator() Implements java.util.SortedMap.comparator. Returns the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys.
public boolean	containsKey(Object key whose presence in this map is to be tested key) Implements java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key.
public boolean	containsValue(Object value whose presence in this map is to be tested value) Implements java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value.
public Set<E>	entrySet() Implements java.util.SortedMap.entrySet. Returns a `Set` view of the mappings contained in this map.
public Object	firstKey() Implements java.util.SortedMap.firstKey. Returns the first (lowest) key currently in this map.
public Object	get(Object the key whose associated value is to be returned key) Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public SortedMap<K, V>	headMap(Object high endpoint (exclusive) of the keys in the returned map toKey) Implements java.util.SortedMap.headMap. Returns a view of the portion of this map whose keys are strictly less than `toKey`.
public boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<E>	keySet() Implements java.util.SortedMap.keySet. Returns a `Set` view of the keys contained in this map.
public Object	lastKey() Implements java.util.SortedMap.lastKey. Returns the last (highest) key currently in this map.
public Object	put(final Object key with which the specified value is to be associated key, final Object value to be associated with the specified key value) Implements java.util.Map.put. Associates the specified value with the specified key in this map (optional operation).
public void	putAll(Map<K, V> mappings to be stored in this map m) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public Object	remove(Object key whose mapping is to be removed from the map key) Implements java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation).
public int	size() Implements java.util.Map.size. Returns the number of key-value mappings in this map.
public SortedMap<K, V>	subMap(Object low endpoint (inclusive) of the keys in the returned map fromKey, Object high endpoint (exclusive) of the keys in the returned map toKey) Implements java.util.SortedMap.subMap. Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive.
public SortedMap<K, V>	tailMap(Object low endpoint (inclusive) of the keys in the returned map fromKey) Implements java.util.SortedMap.tailMap. Returns a view of the portion of this map whose keys are greater than or equal to `fromKey`.
public Collection<E>	values() Implements java.util.SortedMap.values. Returns a `Collection` view of the values contained in this map.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

comparator	back to summary
private final Comparator<T> comparator

set	back to summary
private final PresortedMap.ArraySet set

PresortedMap	back to summary
public PresortedMap()

PresortedMap	back to summary
public PresortedMap(Comparator<T> comparator)

PresortedMap	back to summary
private PresortedMap(Comparator<T> comparator, PresortedMap.ArraySet set)

Method Detail

clear	back to summary
public void clear() Implements java.util.Map.clear. Doc from java.util.Map.clear. Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

clear

back to summary

public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

comparator back to summary

comparator	back to summary
public Comparator<T> comparator() Implements java.util.SortedMap.comparator. Doc from java.util.SortedMap.comparator. Returns the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys. Returns:Comparator<T> the comparator used to order the keys in this map, or `null` if this map uses the natural ordering of its keys

public Comparator<T> comparator()

Implements java.util.SortedMap.comparator.

Doc from java.util.SortedMap.comparator.

Returns the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys.

Returns:Comparator<T>: the comparator used to order the keys in this map, or null if this map uses the natural ordering of its keys

containsKey back to summary

containsKey	back to summary
public boolean containsKey(Object key) Implements java.util.Map.containsKey. Doc from java.util.Map.containsKey. Returns `true` if this map contains a mapping for the specified key. More formally, returns `true` if and only if this map contains a mapping for a key `k` such that `Objects.equals(key, k)`. (There can be at most one such mapping.) Parameters key:Object key whose presence in this map is to be tested Returns:boolean `true` if this map contains a mapping for the specified key

public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters

key:Object: key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

containsValue back to summary

containsValue	back to summary
public boolean containsValue(Object value) Implements java.util.Map.containsValue. Doc from java.util.Map.containsValue. Returns `true` if this map maps one or more keys to the specified value. More formally, returns `true` if and only if this map contains at least one mapping to a value `v` such that `Objects.equals(value, v)`. This operation will probably require time linear in the map size for most implementations of the `Map` interface. Parameters value:Object value whose presence in this map is to be tested Returns:boolean `true` if this map maps one or more keys to the specified value

public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters

value:Object: value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

entrySet back to summary

entrySet	back to summary
public Set<E> entrySet() Implements java.util.SortedMap.entrySet. Doc from java.util.SortedMap.entrySet. Returns a `Set` view of the mappings contained in this map. The set's iterator returns the entries in ascending key order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<E> a set view of the mappings contained in this map, sorted in ascending key order

public Set<E> entrySet()

Implements java.util.SortedMap.entrySet.

Doc from java.util.SortedMap.entrySet.

Returns a Set view of the mappings contained in this map. The set's iterator returns the entries in ascending key order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<E>: a set view of the mappings contained in this map, sorted in ascending key order

firstKey	back to summary
public Object firstKey() Implements java.util.SortedMap.firstKey. Doc from java.util.SortedMap.firstKey. Returns the first (lowest) key currently in this map. Returns:Object the first (lowest) key currently in this map

firstKey

back to summary

public Object firstKey()

Implements java.util.SortedMap.firstKey.

Doc from java.util.SortedMap.firstKey.

Returns the first (lowest) key currently in this map.

Returns:Object: the first (lowest) key currently in this map

get back to summary

get	back to summary
public Object get(Object key) Implements java.util.Map.get. Doc from java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `Objects.equals(key, k)`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) If this map permits null values, then a return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object the key whose associated value is to be returned Returns:Object the value to which the specified key is mapped, or `null` if this map contains no mapping for the key

public Object get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object: the key whose associated value is to be returned

Returns:Object

the value to which the specified key is mapped, or null if this map contains no mapping for the key

headMap back to summary

headMap	back to summary
public SortedMap<K, V> headMap(Object toKey) Implements java.util.SortedMap.headMap. Doc from java.util.SortedMap.headMap. Returns a view of the portion of this map whose keys are strictly less than `toKey`. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports. The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range. Parameters toKey:Object high endpoint (exclusive) of the keys in the returned map Returns:SortedMap<K, V> a view of the portion of this map whose keys are strictly less than `toKey`

public SortedMap<K, V> headMap(Object toKey)

Implements java.util.SortedMap.headMap.

Doc from java.util.SortedMap.headMap.

Returns a view of the portion of this map whose keys are strictly less than toKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters

toKey:Object: high endpoint (exclusive) of the keys in the returned map

Returns:SortedMap<K, V>

a view of the portion of this map whose keys are strictly less than toKey

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Map.isEmpty. Doc from java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings. Returns:boolean `true` if this map contains no key-value mappings

public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean: true if this map contains no key-value mappings

keySet back to summary

keySet	back to summary
public Set<E> keySet() Implements java.util.SortedMap.keySet. Doc from java.util.SortedMap.keySet. Returns a `Set` view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll`, and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Set<E> a set view of the keys contained in this map, sorted in ascending order

public Set<E> keySet()

Implements java.util.SortedMap.keySet.

Doc from java.util.SortedMap.keySet.

Returns a Set view of the keys contained in this map. The set's iterator returns the keys in ascending order. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<E>: a set view of the keys contained in this map, sorted in ascending order

lastKey	back to summary
public Object lastKey() Implements java.util.SortedMap.lastKey. Doc from java.util.SortedMap.lastKey. Returns the last (highest) key currently in this map. Returns:Object the last (highest) key currently in this map

lastKey

back to summary

public Object lastKey()

Implements java.util.SortedMap.lastKey.

Doc from java.util.SortedMap.lastKey.

Returns the last (highest) key currently in this map.

Returns:Object: the last (highest) key currently in this map

put back to summary

put	back to summary
public Object put(final Object key, final Object value) Implements java.util.Map.put. Doc from java.util.Map.put. Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map `m` is said to contain a mapping for a key `k` if and only if `m.containsKey(k)` would return `true`.) Parameters key:Object key with which the specified value is to be associated value:Object value to be associated with the specified key Returns:Object the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`, if the implementation supports `null` values.)

public Object put(final Object key, final Object value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters

key:Object: key with which the specified value is to be associated
value:Object: value to be associated with the specified key

Returns:Object

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

putAll back to summary

putAll	back to summary
public void putAll(Map<K, V> m) Implements java.util.Map.putAll. Doc from java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling `put(k, v)` on this map once for each mapping from key `k` to value `v` in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order. Parameters m:Map<K, V> mappings to be stored in this map

public void putAll(Map<K, V> m)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters

m:Map<K, V>: mappings to be stored in this map

remove back to summary

remove	back to summary
public Object remove(Object key) Implements java.util.Map.remove. Doc from java.util.Map.remove. Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key `k` to value `v` such that `Objects.equals(key, k)`, that mapping is removed. (The map can contain at most one such mapping.) Returns the value to which this map previously associated the key, or `null` if the map contained no mapping for the key. If this map permits null values, then a return value of `null` does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to `null`. The map will not contain a mapping for the specified key once the call returns. Parameters key:Object key whose mapping is to be removed from the map Returns:Object the previous value associated with `key`, or `null` if there was no mapping for `key`.

public Object remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters

key:Object: key whose mapping is to be removed from the map

Returns:Object

the previous value associated with key, or null if there was no mapping for key.

size back to summary

size	back to summary
public int size() Implements java.util.Map.size. Doc from java.util.Map.size. Returns the number of key-value mappings in this map. If the map contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of key-value mappings in this map

public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int: the number of key-value mappings in this map

subMap back to summary

subMap	back to summary
public SortedMap<K, V> subMap(Object fromKey, Object toKey) Implements java.util.SortedMap.subMap. Doc from java.util.SortedMap.subMap. Returns a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive. (If `fromKey` and `toKey` are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports. The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range. Parameters fromKey:Object low endpoint (inclusive) of the keys in the returned map toKey:Object high endpoint (exclusive) of the keys in the returned map Returns:SortedMap<K, V> a view of the portion of this map whose keys range from `fromKey`, inclusive, to `toKey`, exclusive

public SortedMap<K, V> subMap(Object fromKey, Object toKey)

Implements java.util.SortedMap.subMap.

Doc from java.util.SortedMap.subMap.

Returns a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive. (If fromKey and toKey are equal, the returned map is empty.) The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters

fromKey:Object: low endpoint (inclusive) of the keys in the returned map
toKey:Object: high endpoint (exclusive) of the keys in the returned map

Returns:SortedMap<K, V>

a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive

tailMap back to summary

tailMap	back to summary
public SortedMap<K, V> tailMap(Object fromKey) Implements java.util.SortedMap.tailMap. Doc from java.util.SortedMap.tailMap. Returns a view of the portion of this map whose keys are greater than or equal to `fromKey`. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports. The returned map will throw an `IllegalArgumentException` on an attempt to insert a key outside its range. Parameters fromKey:Object low endpoint (inclusive) of the keys in the returned map Returns:SortedMap<K, V> a view of the portion of this map whose keys are greater than or equal to `fromKey`

public SortedMap<K, V> tailMap(Object fromKey)

Implements java.util.SortedMap.tailMap.

Doc from java.util.SortedMap.tailMap.

Returns a view of the portion of this map whose keys are greater than or equal to fromKey. The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa. The returned map supports all optional map operations that this map supports.

The returned map will throw an IllegalArgumentException on an attempt to insert a key outside its range.

Parameters

fromKey:Object: low endpoint (inclusive) of the keys in the returned map

Returns:SortedMap<K, V>

a view of the portion of this map whose keys are greater than or equal to fromKey

values back to summary

values	back to summary
public Collection<E> values() Implements java.util.SortedMap.values. Doc from java.util.SortedMap.values. Returns a `Collection` view of the values contained in this map. The collection's iterator returns the values in ascending order of the corresponding keys. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own `remove` operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Collection.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations. Returns:Collection<E> a collection view of the values contained in this map, sorted in ascending key order

public Collection<E> values()

Implements java.util.SortedMap.values.

Doc from java.util.SortedMap.values.

Returns a Collection view of the values contained in this map. The collection's iterator returns the values in ascending order of the corresponding keys. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<E>: a collection view of the values contained in this map, sorted in ascending key order

Modifier and Type	Field and Description
private Map.Entry<K, V>[]	array
private final ArrayList<E>	list

public Class PresortedMap

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PresortedMap.ArraySet

Constructor Summary

Method Summary

Constructor Detail

private Class PresortedMap.ArraySetComparator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail