Modifier and Type	Class and Description
private class	SmallMap.SmallMapEntry

Modifier and Type	Field and Description
private Object[]	mapArr stores key-value pair as 2 objects; key first; in case of empty map this might be `null`

Access	Constructor and Description
public	SmallMap() Creates empty map.
public	SmallMap(Map<? extends K, ? extends V> the map whose mappings are to be placed in this map initMap) Creates map filled with entries from provided map.

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 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<Map.Entry<K, V>>	entrySet() Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.
private int	findKey(Object key) Returns index of key within map-array or `-1` if key is not found (or key is `null`).
private int	findValue(Object value) Returns index of value within map-array or `-1` if value is not found (or value is `null`).
public V	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 boolean	isEmpty() Implements java.util.Map.isEmpty. Returns `true` if this map contains no key-value mappings.
public Set<K>	keySet() Implements java.util.Map.keySet. Returns a set view of the keys contained in this map.
public V	put(K key with which the specified value is to be associated key, V 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 final void	putAll(Map<? extends K, ? extends V> mappings to be stored in this map otherMap) Implements java.util.Map.putAll. Copies all of the mappings from the specified map to this map (optional operation).
public V	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 Collection<V>	values() Implements java.util.Map.values. Returns a collection of the values contained in this map.

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

Field Detail

mapArr	back to summary
private Object[] mapArr stores key-value pair as 2 objects; key first; in case of empty map this might be `null`

Constructor Detail

SmallMap	back to summary
public SmallMap() Creates empty map.

SmallMap	back to summary
public SmallMap(Map<? extends K, ? extends V> initMap) Creates map filled with entries from provided map. Parameters initMap:Map<? extends K, ? extends V> the map whose mappings are to be placed in this map

SmallMap

back to summary

public SmallMap(Map<? extends K, ? extends V> initMap)

Creates map filled with entries from provided map.

Parameters

initMap:Map<? extends K, ? extends V>: the map whose mappings are to be placed in this map

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. Annotations @Override

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.

Annotations

@Override

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 Annotations @Override

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

Annotations

@Override

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 Annotations @Override

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

Annotations

@Override

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<K, V>> entrySet() Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. 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<Map.Entry<K, V>> a set view of the mappings contained in this map Annotations @Override

public Set<Map.Entry<K, V>> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. 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<Map.Entry<K, V>>

a set view of the mappings contained in this map

Annotations

@Override

findKey	back to summary
private int findKey(Object key) Returns index of key within map-array or `-1` if key is not found (or key is `null`).

findValue	back to summary
private int findValue(Object value) Returns index of value within map-array or `-1` if value is not found (or value is `null`).

get back to summary

get	back to summary
public V 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:V the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @SuppressWarnings:unchecked @Override

public V 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:V

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

Annotations

@SuppressWarnings:unchecked
@Override

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 Annotations @Override

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

Annotations

@Override

keySet	back to summary
public Set<K> keySet() Implements java.util.Map.keySet. Returns a set view of the keys contained in this map. The current implementation does not allow changes to the returned key set (which would have to be reflected in the underlying map. Returns:Set<K> Doc from java.util.Map.keySet. a set view of the keys contained in this map Annotations @SuppressWarnings:unchecked @Override

keySet

back to summary

public Set<K> keySet()

Implements java.util.Map.keySet.

Returns a set view of the keys contained in this map.

The current implementation does not allow changes to the returned key set (which would have to be reflected in the underlying map.

Returns:Set<K>

Doc from java.util.Map.keySet.

a set view of the keys contained in this map

Annotations

@SuppressWarnings:unchecked
@Override

put back to summary

put	back to summary
public V put(K key, V 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:K key with which the specified value is to be associated value:V value to be associated with the specified key Returns:V 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.) Annotations @Override

public V put(K key, V 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:K: key with which the specified value is to be associated
value:V: value to be associated with the specified key

Returns:V

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.)

Annotations

@Override

putAll back to summary

putAll	back to summary
public final void putAll(Map<? extends K, ? extends V> otherMap) 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 otherMap:Map<? extends K, ? extends V> mappings to be stored in this map Annotations @Override

public final void putAll(Map<? extends K, ? extends V> otherMap)

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

otherMap:Map<? extends K, ? extends V>: mappings to be stored in this map

Annotations

@Override

remove back to summary

remove	back to summary
public V 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:V the previous value associated with `key`, or `null` if there was no mapping for `key`. Annotations @Override

public V 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:V

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

Annotations

@Override

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 Annotations @Override

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

Annotations

@Override

values	back to summary
public Collection<V> values() Implements java.util.Map.values. Returns a collection of the values contained in this map. The current implementation does not allow changes to the returned collection (which would have to be reflected in the underlying map. Returns:Collection<V> Doc from java.util.Map.values. a collection view of the values contained in this map Annotations @SuppressWarnings:unchecked @Override

values

back to summary

public Collection<V> values()

Implements java.util.Map.values.

Returns a collection of the values contained in this map.

The current implementation does not allow changes to the returned collection (which would have to be reflected in the underlying map.

Returns:Collection<V>

Doc from java.util.Map.values.

a collection view of the values contained in this map

Annotations

@SuppressWarnings:unchecked
@Override

org.apache.pdfbox.util back to summary

private Class SmallMap.SmallMapEntry

Class Inheritance

extends Object
implements Map.Entry<K, V>

java.lang.Object
org.apache.pdfbox.util.SmallMap.SmallMapEntry

All Implemented Interfaces

java.util.Map.Entry

Field Summary

Modifier and Type	Field and Description
private final int	keyIdx

Constructor Summary

Access	Constructor and Description
pack-priv	SmallMapEntry(int keyInMapIdx)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object object to be compared for equality with this map entry obj) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Compares the specified object with this entry for equality.
public K	getKey() Implements java.util.Map.Entry.getKey. Returns the key corresponding to this entry.
public V	getValue() Implements java.util.Map.Entry.getValue. Returns the value corresponding to this entry.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Returns the hash code value for this map entry.
public V	setValue(V new value to be stored in this entry value) Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).

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

Field Detail

keyIdx	back to summary
private final int keyIdx

Constructor Detail

SmallMapEntry	back to summary
pack-priv SmallMapEntry(int keyInMapIdx)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Doc from java.util.Map.Entry.equals. Compares the specified object with this entry for equality. Returns `true` if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries `e1` and `e2` represent the same mapping if (e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) && (e1.getValue()==null ? e2.getValue()==null : e1.getValue().equals(e2.getValue())) This ensures that the `equals` method works properly across different implementations of the `Map.Entry` interface. Parameters obj:Object object to be compared for equality with this map entry Returns:boolean `true` if the specified object is equal to this map entry Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Doc from java.util.Map.Entry.equals.

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries e1 and e2 represent the same mapping if

    (e1.getKey()==null ?
     e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
    (e1.getValue()==null ?
     e2.getValue()==null : e1.getValue().equals(e2.getValue()))

This ensures that the equals method works properly across different implementations of the Map.Entry interface.

Parameters

obj:Object: object to be compared for equality with this map entry

Returns:boolean

true if the specified object is equal to this map entry

Annotations

@Override

getKey	back to summary
public K getKey() Implements java.util.Map.Entry.getKey. Doc from java.util.Map.Entry.getKey. Returns the key corresponding to this entry. Returns:K the key corresponding to this entry Annotations @SuppressWarnings:unchecked @Override

getKey

back to summary

public K getKey()

Implements java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

Returns:K

the key corresponding to this entry

Annotations

@SuppressWarnings:unchecked
@Override

getValue back to summary

getValue	back to summary
public V getValue() Implements java.util.Map.Entry.getValue. Doc from java.util.Map.Entry.getValue. Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's `remove` operation), the results of this call are undefined. Returns:V the value corresponding to this entry Annotations @SuppressWarnings:unchecked @Override

public V getValue()

Implements java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

Returns:V

the value corresponding to this entry

Annotations

@SuppressWarnings:unchecked
@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Doc from java.util.Map.Entry.hashCode. Returns the hash code value for this map entry. The hash code of a map entry `e` is defined to be: (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ (e.getValue()==null ? 0 : e.getValue().hashCode()) This ensures that `e1.equals(e2)` implies that `e1.hashCode()==e2.hashCode()` for any two Entries `e1` and `e2`, as required by the general contract of `Object.hashCode`. Returns:int the hash code value for this map entry Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Doc from java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry. The hash code of a map entry e is defined to be:

    (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
    (e.getValue()==null ? 0 : e.getValue().hashCode())

This ensures that e1.equals(e2) implies that e1.hashCode()==e2.hashCode() for any two Entries e1 and e2, as required by the general contract of Object.hashCode.

Returns:int

the hash code value for this map entry

Annotations

@Override

setValue back to summary

setValue	back to summary
public V setValue(V value) Implements java.util.Map.Entry.setValue. Doc from java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's `remove` operation). Parameters value:V new value to be stored in this entry Returns:V old value corresponding to the entry Annotations @Override

public V setValue(V value)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

Parameters

value:V: new value to be stored in this entry

Returns:V

old value corresponding to the entry

Annotations

@Override

public Class SmallMap<K, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SmallMap.SmallMapEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail