sample/java.util.AbstractMap.SimpleImmutableEntry.txt

   1 *java.util.AbstractMap.SimpleImmutableEntry* *AbstractMap.SimpleImmutableEntry*
   2
   3 public static class AbstractMap.SimpleImmutableEntry<K,V>
   4   extends    |java.lang.Object|
   5   implements |java.util.Map.Entry|
   6              |java.io.Serializable|
   7
   8 |java.util.AbstractMap.SimpleImmutableEntry_Description|
   9 |java.util.AbstractMap.SimpleImmutableEntry_Fields|
  10 |java.util.AbstractMap.SimpleImmutableEntry_Constructors|
  11 |java.util.AbstractMap.SimpleImmutableEntry_Methods|
  12
  13 ================================================================================
  14
  15 *java.util.AbstractMap.SimpleImmutableEntry_Constructors*
  16 |java.util.AbstractMap.SimpleImmutableEntry(K,V)|Creates an entry representing
  17 |java.util.AbstractMap.SimpleImmutableEntry(Map.Entry<?extendsK,?extendsV>)|Cre
  18
  19 *java.util.AbstractMap.SimpleImmutableEntry_Methods*
  20 |java.util.AbstractMap.SimpleImmutableEntry.equals(Object)|Compares the specifi
  21 |java.util.AbstractMap.SimpleImmutableEntry.getKey()|Returns the key correspond
  22 |java.util.AbstractMap.SimpleImmutableEntry.getValue()|Returns the value corres
  23 |java.util.AbstractMap.SimpleImmutableEntry.hashCode()|Returns the hash code va
  24 |java.util.AbstractMap.SimpleImmutableEntry.setValue(V)|Replaces the value corr
  25 |java.util.AbstractMap.SimpleImmutableEntry.toString()|Returns a String represe
  26
  27 *java.util.AbstractMap.SimpleImmutableEntry_Description*
  28
  29 An Entry maintaining an immutable key and value. This class does not support
  30 method setValue. This class may be convenient in methods that return
  31 thread-safe snapshots of key-value mappings.
  32
  33
  34
  35 *java.util.AbstractMap.SimpleImmutableEntry(K,V)*
  36
  37 public AbstractMap.SimpleImmutableEntry(
  38   K key,
  39   V value)
  40
  41 Creates an entry representing a mapping from the specified key to the specified
  42 value.
  43
  44     key - the key represented by this entry
  45     value - the value represented by this entry
  46
  47 *java.util.AbstractMap.SimpleImmutableEntry(Map.Entry<?extendsK,?extendsV>)*
  48
  49 public AbstractMap.SimpleImmutableEntry(java.util.Map.Entry<? extends K, ? extends V> entry)
  50
  51 Creates an entry representing the same mapping as the specified entry.
  52
  53     entry - the entry to copy
  54
  55 *java.util.AbstractMap.SimpleImmutableEntry.equals(Object)*
  56
  57 public boolean equals(java.lang.Object o)
  58
  59 Compares the specified object with this entry for equality. Returnstrueif the
  60 given object is also a map entry and the two entries represent the same
  61 mapping.        More formally, two entriese1ande2represent the same mapping if
  62
  63 (e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) and
  64 and (e1.getValue()==null ? e2.getValue()==null :
  65 e1.getValue().equals(e2.getValue()))
  66
  67 This ensures that theequalsmethod works properly across different
  68 implementations of theMap.Entryinterface.
  69
  70
  71     o - object to be compared for equality with this map entry
  72
  73     Returns: {@code true} if the specified object is equal to this map entry
  74
  75 *java.util.AbstractMap.SimpleImmutableEntry.getKey()*
  76
  77 public |K| getKey()
  78
  79 Returns the key corresponding to this entry.
  80
  81
  82
  83     Returns: the key corresponding to this entry
  84
  85 *java.util.AbstractMap.SimpleImmutableEntry.getValue()*
  86
  87 public |V| getValue()
  88
  89 Returns the value corresponding to this entry.
  90
  91
  92
  93     Returns: the value corresponding to this entry
  94
  95 *java.util.AbstractMap.SimpleImmutableEntry.hashCode()*
  96
  97 public int hashCode()
  98
  99 Returns the hash code value for this map entry. The hash code of a map entryeis
 100 defined to be:
 101
 102 (e.getKey()==null ? 0 : e.getKey().hashCode()) ^ (e.getValue()==null ? 0 :
 103 e.getValue().hashCode())
 104
 105 This ensures thate1.equals(e2)implies thate1.hashCode()==e2.hashCode()for any
 106 two Entriese1ande2, as required by the general contract of (|java.lang.Object|)
 107 .
 108
 109
 110
 111     Returns: the hash code value for this map entry
 112
 113 *java.util.AbstractMap.SimpleImmutableEntry.setValue(V)*
 114
 115 public |V| setValue(V value)
 116
 117 Replaces the value corresponding to this entry with the specified value
 118 (optional operation). This implementation simply throws
 119 UnsupportedOperationException, as this class implements an immutable map entry.
 120
 121
 122     value - new value to be stored in this entry
 123
 124     Returns: (Does not return)
 125
 126 *java.util.AbstractMap.SimpleImmutableEntry.toString()*
 127
 128 public |java.lang.String| toString()
 129
 130 Returns a String representation of this map entry. This implementation returns
 131 the string representation of this entry's key followed by the equals character
 132 ("=") followed by the string representation of this entry's value.
 133
 134
 135
 136     Returns: a String representation of this map entry
 137
 138