Module bus.setting

Package org.miaixz.bus.setting.magic

Class GroupedMap

java.lang.Object

java.util.AbstractMap<String,LinkedHashMap<String,String>>

java.util.HashMap<String,LinkedHashMap<String,String>>

java.util.LinkedHashMap<String,LinkedHashMap<String,String>>

org.miaixz.bus.setting.magic.GroupedMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,LinkedHashMap<String,String>>, SequencedMap<String,LinkedHashMap<String,String>>

public class GroupedMap
extends LinkedHashMap<String,LinkedHashMap<String,String>>

A thread-safe, group-based map implementation, extending LinkedHashMap. It organizes key-value pairs into named groups, where each group is a LinkedHashMap<String, String>.

Since:

Java 17+

Author:

Kimi Liu

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor	Description
GroupedMap()

Method Summary

Modifier and Type	Method	Description
GroupedMap	clear(String group)	Clears all key-value pairs from a specific group.
boolean	containsKey(String group, String key)	Checks if a specific group contains a given key.
boolean	containsValue(String group, String value)	Checks if a specific group contains a given value.
Set<Map.Entry<String,LinkedHashMap<String,String>>>	entrySet()
Set<Map.Entry<String,String>>	entrySet(String group)	Returns a set of all key-value entries within a specific group.
String	get(CharSequence group, CharSequence key)	Gets a value for a given key within a specific group.
LinkedHashMap<String,String>	get(Object key)
boolean	isEmpty()	Checks if this grouped map contains any key-value pairs across all groups.
boolean	isEmpty(String group)	Checks if a specific group is empty.
Set<String>	keySet()
Set<String>	keySet(String group)	Returns a set of all keys within a specific group.
String	put(String group, String key, String value)	Puts a key-value pair into a specific group.
GroupedMap	putAll(String group, Map<? extends String,? extends String> m)	Puts all key-value pairs from a map into a specific group.
String	remove(String group, String key)	Removes a key-value pair from a specific group.
int	size()	Returns the total number of key-value pairs across all groups.
String	toString()
Collection<String>	values(String group)	Returns a collection of all values within a specific group.

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, forEach, getOrDefault, newLinkedHashMap, putFirst, putLast, removeEldestEntry, replaceAll, reversed, sequencedEntrySet, sequencedKeySet, sequencedValues, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, merge, newHashMap, put, putAll, putIfAbsent, remove, remove, replace, replace

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, merge, put, putAll, putIfAbsent, remove, remove, replace, replace

Methods inherited from interface java.util.SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry

Constructor Details

GroupedMap

public GroupedMap()

Method Details

get

public String get(CharSequence group,
 CharSequence key)

Gets a value for a given key within a specific group.

Parameters:

group - The group name.

key - The key within the group.

Returns:

The value, or null if the group or key does not exist.

get

public LinkedHashMap<String,String> get(Object key)

Specified by:

get in interface Map<String,LinkedHashMap<String,String>>

Overrides:

get in class LinkedHashMap<String,LinkedHashMap<String,String>>

size

public int size()

Returns the total number of key-value pairs across all groups.

Specified by:

size in interface Map<String,LinkedHashMap<String,String>>

Overrides:

size in class HashMap<String,LinkedHashMap<String,String>>

Returns:

The total size.

put

public String put(String group,
 String key,
 String value)

Puts a key-value pair into a specific group.

Parameters:

group - The group name. If null or empty, the default group is used.

key - The key.

value - The value.

Returns:

The previous value associated with the key, or null if there was none.

putAll

public GroupedMap putAll(String group,
 Map<? extends String,? extends String> m)

Puts all key-value pairs from a map into a specific group.

Parameters:

group - The group name.

m - The map of key-value pairs to add.

Returns:

This GroupedMap instance.

remove

public String remove(String group,
 String key)

Removes a key-value pair from a specific group.

Parameters:

group - The group name.

key - The key to remove.

Returns:

The value that was removed, or null if the key was not found.

isEmpty

public boolean isEmpty(String group)

Checks if a specific group is empty.

Parameters:

group - The group name.

Returns:

true if the group does not exist or has no entries.

isEmpty

public boolean isEmpty()

Checks if this grouped map contains any key-value pairs across all groups.

Specified by:

isEmpty in interface Map<String,LinkedHashMap<String,String>>

Overrides:

isEmpty in class HashMap<String,LinkedHashMap<String,String>>

Returns:

true if this map is empty.

containsKey

public boolean containsKey(String group,
 String key)

Checks if a specific group contains a given key.

Parameters:

group - The group name.

key - The key to check for.

Returns:

true if the key exists in the group.

containsValue

public boolean containsValue(String group,
 String value)

Checks if a specific group contains a given value.

Parameters:

group - The group name.

value - The value to check for.

Returns:

true if the value exists in the group.

clear

public GroupedMap clear(String group)

Clears all key-value pairs from a specific group.

Parameters:

group - The group name to clear.

Returns:

This GroupedMap instance.

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,LinkedHashMap<String,String>>

Overrides:

keySet in class LinkedHashMap<String,LinkedHashMap<String,String>>

keySet

public Set<String> keySet(String group)

Returns a set of all keys within a specific group.

Parameters:

group - The group name.

Returns:

The set of keys.

values

public Collection<String> values(String group)

Returns a collection of all values within a specific group.

Parameters:

group - The group name.

Returns:

The collection of values.

entrySet

public Set<Map.Entry<String,LinkedHashMap<String,String>>> entrySet()

Specified by:

entrySet in interface Map<String,LinkedHashMap<String,String>>

Overrides:

entrySet in class LinkedHashMap<String,LinkedHashMap<String,String>>

entrySet

public Set<Map.Entry<String,String>> entrySet(String group)

Returns a set of all key-value entries within a specific group.

Parameters:

group - The group name.

Returns:

The set of entries.

toString

public String toString()

Overrides:

toString in class AbstractMap<String,LinkedHashMap<String,String>>