sample/java.util.AbstractMap.SimpleEntry.txt

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