net.sf.plist.defaults

Class NSDefaults

java.lang.Object

net.sf.plist.defaults.NSDefaults

All Implemented Interfaces:

java.util.Map<java.lang.String,NSObject>, java.util.SortedMap<java.lang.String,NSObject>

public final class NSDefaults
extends java.lang.Object
implements java.util.SortedMap<java.lang.String,NSObject>

NSDefaults is an implementation of the defaults system used in Mac OS X. The defaults system provides every program that uses it with a key/value store. Keys are Strings, values are NSObjects. NSDefaults behaves like NSDictionary in the sense that both represent key/value pairs in property list files, but NSDictionary is linked to a specific file and is editable.

It is possible to directly instantiate NSDefaults but this is discouraged. The preferred way to instantiate NSDefaults is by using the getInstance(Object, Scope) method, which will instantiate NSDefaults for the domain the Object belongs to.

In this implementation the package name is used to derive the domain. The standard way to determine the domain is by taking the first three parts of the package name. This behaviour can be overridden by using the addDomain(String) method, which will cause the domain to be "learned".
If the beginning of a package name matches a learned domain, the learned domain is used.

Nested Class Summary

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

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static net.sf.plist.defaults.OperatingSystemPath	OSPATH Instance of OperatingSystemPath for current operating system

Constructor Summary

Constructors

Constructor and Description
NSDefaults(java.io.File file) Construct using a fixed file.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDomain(java.lang.String domain) "Learn" a domain
void	clear()
void	commit() Write all changes to the Property List file
java.util.Comparator<? super java.lang.String>	comparator()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,NSObject>>	entrySet()
java.lang.String	firstKey()
NSObject	get(java.lang.Object key)
static java.lang.String	getDomainForName(java.lang.String canonicalName) Translate a canonicalName to a domain
static java.lang.String[]	getDomains() Return an array of all domains known to NSDefaults This includes both domains added through addDomain(String) as well as domains already in used on the local computer
static NSDefaults	getGlobalInstance(Scope scope) Get the global domain instance
static NSDefaults	getInstance(java.lang.Class<?> baseClass, Scope scope) Get instance for a given class
static NSDefaults	getInstance(java.lang.Object baseObject, Scope scope) Get instance for a given object
static NSDefaults	getInstance(java.lang.String domain, Scope scope) Get instance for a given domain
Scope	getScope() Get the scope for this instance.
java.util.SortedMap<java.lang.String,NSObject>	headMap(java.lang.String toKey)
static void	initDomains()
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.String	lastKey()
static void	main(java.lang.String... args)
NSObject	put(java.lang.String key, NSObject value)
void	putAll(java.util.Map<? extends java.lang.String,? extends NSObject> m)
void	refresh() Re-read all information from the Property List file
NSObject	remove(java.lang.Object key)
int	size()
java.util.SortedMap<java.lang.String,NSObject>	subMap(java.lang.String fromKey, java.lang.String toKey)
java.util.SortedMap<java.lang.String,NSObject>	tailMap(java.lang.String fromKey)
NSDictionary	toDictionary() Get the root of this NSDefaults as NSDictionary
java.util.Collection<NSObject>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

OSPATH

public static final net.sf.plist.defaults.OperatingSystemPath OSPATH

Instance of OperatingSystemPath for current operating system

Constructor Detail

NSDefaults

public NSDefaults(java.io.File file)

Construct using a fixed file. Invocation of this constructor is discouraged, use getInstance(Object, Scope) instead.

Parameters:

file - The PList file used, the file may be overwritten

Method Detail

initDomains

public static void initDomains()

main

public static void main(java.lang.String... args)

commit

public void commit()
            throws PropertyListException,
                   java.io.IOException

Write all changes to the Property List file

Throws:

PropertyListException - constructing the Property List file failed

java.io.IOException - writing the file failed

refresh

public void refresh()

Re-read all information from the Property List file

getGlobalInstance

public static final NSDefaults getGlobalInstance(Scope scope)

Get the global domain instance

Parameters:

scope - the scope

Returns:

the instance

getInstance

public static final NSDefaults getInstance(java.lang.String domain,
                     Scope scope)

Get instance for a given domain

Parameters:

domain - the domain, null for the global preferences

scope - the scope

Returns:

the instance

getInstance

public static final NSDefaults getInstance(java.lang.Class<?> baseClass,
                     Scope scope)

Get instance for a given class

Parameters:

baseClass - the class

scope - the scope

Returns:

the instance

getInstance

public static final NSDefaults getInstance(java.lang.Object baseObject,
                     Scope scope)

Get instance for a given object

Parameters:

baseObject - the object

scope - the scope

Returns:

the instance

getDomainForName

public static java.lang.String getDomainForName(java.lang.String canonicalName)

Translate a canonicalName to a domain

Parameters:

canonicalName - the canonical name

Returns:

the domain

addDomain

public static void addDomain(java.lang.String domain)

"Learn" a domain

Parameters:

domain - the domain

getDomains

public static java.lang.String[] getDomains()

Return an array of all domains known to NSDefaults This includes both domains added through addDomain(String) as well as domains already in used on the local computer

Returns:

array containing all known domains

toDictionary

public NSDictionary toDictionary()

Get the root of this NSDefaults as NSDictionary

Returns:

the dictionary

getScope

public Scope getScope()

Get the scope for this instance. The scope is null if this object was created using the public constructor.

Returns:

the scope

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,NSObject>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,NSObject>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,NSObject>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,NSObject>

get

public NSObject get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,NSObject>

put

public NSObject put(java.lang.String key,
           NSObject value)

Specified by:

put in interface java.util.Map<java.lang.String,NSObject>

remove

public NSObject remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,NSObject>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends NSObject> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,NSObject>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,NSObject>

comparator

public java.util.Comparator<? super java.lang.String> comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.String,NSObject>

subMap

public java.util.SortedMap<java.lang.String,NSObject> subMap(java.lang.String fromKey,
                                                    java.lang.String toKey)

Specified by:

subMap in interface java.util.SortedMap<java.lang.String,NSObject>

headMap

public java.util.SortedMap<java.lang.String,NSObject> headMap(java.lang.String toKey)

Specified by:

headMap in interface java.util.SortedMap<java.lang.String,NSObject>

tailMap

public java.util.SortedMap<java.lang.String,NSObject> tailMap(java.lang.String fromKey)

Specified by:

tailMap in interface java.util.SortedMap<java.lang.String,NSObject>

firstKey

public java.lang.String firstKey()

Specified by:

firstKey in interface java.util.SortedMap<java.lang.String,NSObject>

lastKey

public java.lang.String lastKey()

Specified by:

lastKey in interface java.util.SortedMap<java.lang.String,NSObject>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,NSObject>

Specified by:

keySet in interface java.util.SortedMap<java.lang.String,NSObject>

values

public java.util.Collection<NSObject> values()

Specified by:

values in interface java.util.Map<java.lang.String,NSObject>

Specified by:

values in interface java.util.SortedMap<java.lang.String,NSObject>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,NSObject>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,NSObject>

Specified by:

entrySet in interface java.util.SortedMap<java.lang.String,NSObject>