SimpleEntry

An Entry maintaining a key and a value. The value may be changed using the <tt>setValue</tt> method. This class facilitates the process of building custom map implementations. For example, it may be convenient to return arrays of <tt>SimpleEntry</tt> instances in method <tt>Map.entrySet().toArray</tt>.

class SimpleEntry : MapEntry!(K, V)(

) {

this(K key, V value);

this(MapEntry!(K, V) entry);

K getKey();

V getValue();

V setValue(V value);

bool opEquals(Object o);

bool opEquals(IObject o);

int opCmp(MapEntry!(K, V) o);

alias opCmp = Object.opCmp;

size_t toHash();

string toString();

}

Constructors

this this(K key, V value): Creates an entry representing a mapping from the specified key to the specified value.
this this(MapEntry!(K, V) entry): Creates an entry representing the same mapping as the specified entry.

Members

Aliases

opCmp alias opCmp = Object.opCmp: Undocumented in source.

Functions

getKey K getKey(): Returns the key corresponding to this entry.
getValue V getValue(): Returns the value corresponding to this entry.
opCmp int opCmp(MapEntry!(K, V) o): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Object o): Compares the specified object with this entry for equality. Returns {@code true} if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries {@code e1} and {@code e2} represent the same mapping if<pre> (e1.getKey()==null ? e2.getKey()==null : e1.getKey().equals(e2.getKey())) && (e1.getValue()==null ? e2.getValue()==null : e1.getValue().equals(e2.getValue()))</pre> This ensures that the {@code equals} method works properly across different implementations of the {@code MapEntry} interface.
opEquals bool opEquals(IObject o): Undocumented in source. Be warned that the author may not have intended to support it.
setValue V setValue(V value): Replaces the value corresponding to this entry with the specified value.
toHash size_t toHash(): Returns the hash code value for this map entry. The hash code of a map entry {@code e} is defined to be: <pre> (e.getKey()==null ? 0 : e.getKey().toHash()) ^ (e.getValue()==null ? 0 : e.getValue().toHash())</pre> This ensures that {@code e1.equals(e2)} implies that {@code e1.toHash()==e2.toHash()} for any two Entries {@code e1} and {@code e2}, as required by the general contract of {@link Object#toHash}.
toString string toString(): Returns a string representation of this map entry. This implementation returns the string representation of this entry's key followed by the equals character ("<tt>=</tt>") followed by the string representation of this entry's value.

SimpleEntry

Constructors

Members

Aliases

Functions

Meta

Source