NSDictionary (dd-plist 1.22 API)

java.lang.Object
- com.dd.plist.NSObject
- - com.dd.plist.NSDictionary

All Implemented Interfaces:

Cloneable, Map<String,NSObject>
```
public class NSDictionary
extends NSObject
implements Map<String,NSObject>
```
The NSDictionary class is a collection of NSObject instances that are identified by strings. It represents a hash map where the keys are strings and the values NSObject instances. The implementation is based on a linked hash map, so that the order of the elements in the dictionary is preserved. You can access the keys through the function allKeys(). Access to the objects stored for each key is given through the function objectForKey(String key).

Author:

Daniel Dreibrodt

See Also:

Foundation NSDictionary documentation, LinkedHashMap

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

NSDictionary()
Creates a new NSDictionary instance.

Constructors
Constructor and Description
`NSDictionary()` Creates a new NSDictionary instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`allKeys()` Gets a list of all keys used in this NSDictionary.
`void`	`clear()` Removes all key-value pairs from this dictionary.
`NSDictionary`	`clone()` Creates and returns a deep copy of this instance.
`boolean`	`containsKey(Object key)`
`boolean`	`containsKey(String key)` Checks whether a given key is contained in this dictionary.
`boolean`	`containsValue(boolean val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(byte[] val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(Date val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(double val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(long val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(NSObject val)` Checks whether a given value is contained in this dictionary.
`boolean`	`containsValue(Object value)`
`boolean`	`containsValue(String val)` Checks whether a given value is contained in this dictionary.
`int`	`count()` Counts the number of contained key-value pairs.
`Set<Map.Entry<String,NSObject>>`	`entrySet()`
`boolean`	`equals(Object obj)`
`NSObject`	`get(Object key)`
`HashMap<String,NSObject>`	`getHashMap()` Gets the hash map which stores the keys and values of this dictionary.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`NSObject`	`objectForKey(String key)` Gets the NSObject stored for the given key.
`NSObject`	`put(String key, NSObject obj)` Puts a new key-value pair into this dictionary.
`NSObject`	`put(String key, Object obj)` Puts a new key-value pair into this dictionary.
`void`	`putAll(Map<? extends String,? extends NSObject> values)`
`NSObject`	`remove(Object key)`
`NSObject`	`remove(String key)` Removes a key-value pair from this dictionary.
`int`	`size()`
`protected void`	`toASCII(StringBuilder ascii, int level)` Generates the ASCII representation of this object.
`protected void`	`toASCIIGnuStep(StringBuilder ascii, int level)` Generates the ASCII representation of this object in the GnuStep format.
`String`	`toASCIIPropertyList()` Generates a valid ASCII property list which has this NSDictionary as its root object.
`String`	`toGnuStepASCIIPropertyList()` Generates a valid ASCII property list in GnuStep format which has this NSDictionary as its root object.
`Collection<NSObject>`	`values()`

Methods inherited from class com.dd.plist.NSObject
fromJavaObject, toJavaObject, toJavaObject, toXMLPropertyList

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - NSDictionary
```
public NSDictionary()
```
    Creates a new NSDictionary instance.
- Method Detail
  - getHashMap
```
public HashMap<String,NSObject> getHashMap()
```
    Gets the hash map which stores the keys and values of this dictionary. Changes to the hash map are directly reflected in this dictionary.
    
    Returns:
    
    The hash map which is used by this dictionary to store its contents.
  - objectForKey
```
public NSObject objectForKey(String key)
```
    Gets the NSObject stored for the given key.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    The object.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,NSObject>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,NSObject>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,NSObject>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,NSObject>
  - get
```
public NSObject get(Object key)
```
    Specified by:
    
    get in interface Map<String,NSObject>
  - putAll
```
public void putAll(Map<? extends String,? extends NSObject> values)
```
    Specified by:
    
    putAll in interface Map<String,NSObject>
  - put
```
public NSObject put(String key,
                    NSObject obj)
```
    Puts a new key-value pair into this dictionary. If the value is null, no operation will be performed on the dictionary.
    
    Specified by:
    
    put in interface Map<String,NSObject>
    
    Parameters:
    
    key - The key.
    
    obj - The value.
    
    Returns:
    
    The value previously associated to the given key, or null, if no value was associated to it.
  - put
```
public NSObject put(String key,
                    Object obj)
```
    Puts a new key-value pair into this dictionary. If key or value are null, no operation will be performed on the dictionary.
    
    Parameters:
    
    key - The key.
    
    obj - The value. Supported object types are numbers, byte-arrays, dates, strings and arrays or sets of those.
    
    Returns:
    
    The value previously associated to the given key, or null, if no value was associated to it.
  - remove
```
public NSObject remove(String key)
```
    Removes a key-value pair from this dictionary.
    
    Parameters:
    
    key - The key
    
    Returns:
    
    the value previously associated to the given key.
  - remove
```
public NSObject remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,NSObject>
  - clear
```
public void clear()
```
    Removes all key-value pairs from this dictionary.
    
    Specified by:
    
    clear in interface Map<String,NSObject>
    
    See Also:
    
    Map.clear()
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,NSObject>
  - values
```
public Collection<NSObject> values()
```
    Specified by:
    
    values in interface Map<String,NSObject>
  - entrySet
```
public Set<Map.Entry<String,NSObject>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,NSObject>
  - containsKey
```
public boolean containsKey(String key)
```
    Checks whether a given key is contained in this dictionary.
    
    Parameters:
    
    key - The key that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(NSObject val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(String val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(long val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(double val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(boolean val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(Date val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - containsValue
```
public boolean containsValue(byte[] val)
```
    Checks whether a given value is contained in this dictionary.
    
    Parameters:
    
    val - The value that will be searched for.
    
    Returns:
    
    Whether the key is contained in this dictionary.
  - count
```
public int count()
```
    Counts the number of contained key-value pairs.
    
    Returns:
    
    The size of this NSDictionary.
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Map<String,NSObject>
    
    Overrides:
    
    equals in class Object
  - allKeys
```
public String[] allKeys()
```
    Gets a list of all keys used in this NSDictionary.
    
    Returns:
    
    The list of all keys used in this NSDictionary.
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,NSObject>
    
    Overrides:
    
    hashCode in class Object
  - clone
```
public NSDictionary clone()
```
    Description copied from class: NSObject
    
    Creates and returns a deep copy of this instance.
    
    Specified by:
    
    clone in class NSObject
    
    Returns:
    
    A clone of this instance.
  - toASCIIPropertyList
```
public String toASCIIPropertyList()
```
    Generates a valid ASCII property list which has this NSDictionary as its root object. The generated property list complies with the format as described in Property List Programming Guide - Old-Style ASCII Property Lists.
    
    Returns:
    
    ASCII representation of this object.
  - toGnuStepASCIIPropertyList
```
public String toGnuStepASCIIPropertyList()
```
    Generates a valid ASCII property list in GnuStep format which has this NSDictionary as its root object. The generated property list complies with the format as described in GnuStep - NSPropertyListSerialization class documentation
    
    Returns:
    
    GnuStep ASCII representation of this object.
  - toASCII
```
protected void toASCII(StringBuilder ascii,
                       int level)
```
    Description copied from class: NSObject
    
    Generates the ASCII representation of this object. The generated ASCII representation does not end with a newline. Complies with the Old-Style ASCII Property Lists definition.
    
    Specified by:
    
    toASCII in class NSObject
    
    Parameters:
    
    ascii - The StringBuilder onto which the ASCII representation is appended.
    
    level - The indentation level of the object.
  - toASCIIGnuStep
```
protected void toASCIIGnuStep(StringBuilder ascii,
                              int level)
```
    Description copied from class: NSObject
    
    Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation does not end with a newline.
    
    Specified by:
    
    toASCIIGnuStep in class NSObject
    
    Parameters:
    
    ascii - The StringBuilder onto which the ASCII representation is appended.
    
    level - The indentation level of the object.

Class NSDictionary

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.dd.plist.NSObject

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

NSDictionary

Method Detail

getHashMap

objectForKey

size

isEmpty

containsKey

containsValue

get

putAll

put

put

remove

remove

clear

keySet

values

entrySet

containsKey

containsValue

containsValue

containsValue

containsValue

containsValue

containsValue

containsValue

count

equals

allKeys

hashCode

clone

toASCIIPropertyList

toGnuStepASCIIPropertyList

toASCII

toASCIIGnuStep