de.frame4j.util

Class PropMap.EntrySet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Map.Entry<CharSequence,String>>

de.frame4j.util.PropMap.EntrySet

All Implemented Interfaces:

Iterable<Map.Entry<CharSequence,String>>, Collection<Map.Entry<CharSequence,String>>, Set<Map.Entry<CharSequence,String>>

Enclosing class:

PropMap

public final class PropMap.EntrySet
extends AbstractSet<Map.Entry<CharSequence,String>>
implements Set<Map.Entry<CharSequence,String>>

The entries as Set.

An object of this inner class features a set view of the enclosing PropMap's entries.

That EntrySet object always mirrors (1:1) the enclosing PropMap's state. For that reason on will get just one (pseudo singleton per PropMap) PropMap.EntrySet object no matter how many are requested.

Hint: The seldom used (partly expensive or not recommended) methods AbstractCollection.retainAll(java.util.Collection), AbstractSet.removeAll(java.util.Collection), AbstractCollection.containsAll(java.util.Collection), AbstractCollection.addAll(java.util.Collection) and AbstractCollection.toArray(Object[]) are unchanged inheritance.


© Copyright 2004 Albrecht Weinert.

Version:

like the enclosing class PropMap

Author:

Albrecht Weinert

See Also:

Map.size(), PropMap.size()

Method Summary

Modifier and Type	Method and Description
boolean	add(Map.Entry<CharSequence,String> e) Add an entry.
void	clear() Delete all entries.
boolean	contains(Object o) Is an Entry contained.
boolean	equals(Object other) Equality with other object.
int	hashCode() HashCode (of the enclosing PropMap).
boolean	isEmpty() Is it empty.
Iterator<Map.Entry<CharSequence,String>>	iterator() An Iterator over all entries.
boolean	remove(Object o) Remove an entry.
int	size() Number of entries.
Object[]	toArray() The entries as array.

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, removeAll, retainAll, spliterator, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

size

public int size()

Number of entries.

Specified by:

size in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

size in interface Set<Map.Entry<CharSequence,String>>

Specified by:

size in class AbstractCollection<Map.Entry<CharSequence,String>>

Returns:

PropMap.size()

See Also:

Map.size()

hashCode

public int hashCode()

HashCode (of the enclosing PropMap).

Specified by:

hashCode in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

hashCode in interface Set<Map.Entry<CharSequence,String>>

Overrides:

hashCode in class AbstractSet<Map.Entry<CharSequence,String>>

equals

public boolean equals(Object other)

Equality with other object.

Returns true is the enclosing PropMap share the same internal entries array.

Specified by:

equals in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

equals in interface Set<Map.Entry<CharSequence,String>>

Overrides:

equals in class AbstractSet<Map.Entry<CharSequence,String>>

Parameters:

other - the object to compare to

Returns:

true if other is an EntrySet holding the same entries

clear

public void clear()

Delete all entries.

Deletes all entries of the enclosing PropMap (by calling clear()).

Specified by:

clear in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

clear in interface Set<Map.Entry<CharSequence,String>>

Overrides:

clear in class AbstractCollection<Map.Entry<CharSequence,String>>

See Also:

AbstractCollection.clear(), PropMap.clear()

isEmpty

public final boolean isEmpty()

Is it empty.

Specified by:

isEmpty in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

isEmpty in interface Set<Map.Entry<CharSequence,String>>

Overrides:

isEmpty in class AbstractCollection<Map.Entry<CharSequence,String>>

See Also:

AbstractCollection.isEmpty()

add

public boolean add(Map.Entry<CharSequence,String> e)

Add an entry.

Specified by:

add in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

add in interface Set<Map.Entry<CharSequence,String>>

Overrides:

add in class AbstractCollection<Map.Entry<CharSequence,String>>

remove

public boolean remove(Object o)

Remove an entry.

If an entry equal to o is found in the enclosing PropMap it is removed.

Specified by:

remove in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

remove in interface Set<Map.Entry<CharSequence,String>>

Overrides:

remove in class AbstractCollection<Map.Entry<CharSequence,String>>

toArray

public Object[] toArray()

The entries as array.

This method returns an array of all entries of the enclosing PropMap. It is dense (contains no null) and is of the actual size.

Specified by:

toArray in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

toArray in interface Set<Map.Entry<CharSequence,String>>

Overrides:

toArray in class AbstractCollection<Map.Entry<CharSequence,String>>

Returns:

an array of (Entry[]), may be empty but never null

See Also:

AbstractCollection.toArray()

iterator

public Iterator<Map.Entry<CharSequence,String>> iterator()

An Iterator over all entries.

This method returns an Iterator over all entries. Even though generating a new Iterator object, the call is relatively cheap.

If the underlying PropMap is modified by others while using the returned Iterator (against the intended use case pattern) the Iterator's behaviour can get unpredictable.

Specified by:

iterator in interface Iterable<Map.Entry<CharSequence,String>>

Specified by:

iterator in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

iterator in interface Set<Map.Entry<CharSequence,String>>

Specified by:

iterator in class AbstractCollection<Map.Entry<CharSequence,String>>

Returns:

A new Iterator object

contains

public boolean contains(Object o)

Is an Entry contained.

This method returns true if o is of the type PropMapHelper.Entry and contained in the underlying PropMap object.

Specified by:

contains in interface Collection<Map.Entry<CharSequence,String>>

Specified by:

contains in interface Set<Map.Entry<CharSequence,String>>

Overrides:

contains in class AbstractCollection<Map.Entry<CharSequence,String>>

Parameters:

o - entry to look for

Returns:

true if contained in this map