PreferenceScope (Oracle Fusion Middleware Java API Reference for Oracle Mobile Application Framework)

Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap
  - - oracle.adfmf.framework.Scope
    - - oracle.adf.model.datacontrols.device.PreferenceScope

All Implemented Interfaces:

java.io.Serializable, Cloneable, java.util.Map
```
public class PreferenceScope
extends oracle.adfmf.framework.Scope
```
Embedded Java side for preferences.

The preferences with the following scopes will be persisted and have EL expressions created for them:
application
feature
oracle
internal
dynamic

The preferences with the following scope will be not persisted but will have EL expressions created for them:
volatile

Developers that want to add preferences to the system at runtime are encouraged to use the dynamic scope.

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

PreferenceScope()

PreferenceScope(String branchName)

Constructors
Constructor and Description
`PreferenceScope()`
`PreferenceScope(String branchName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(Object arg0)`
`boolean`	`containsValue(Object arg0)`
`java.util.Set`	`entrySet()`
`Object`	`get(Object key)`
`static PreferenceScope`	`getInstance()`
`boolean`	`isEmpty()`
`java.util.Set`	`keySet()`
`void`	`populatePreferencesMap(java.util.HashMap preferences)` populate a subset of the preferences map starting at the top
`Object`	`put(Object key, Object value)`
`void`	`putAll(java.util.Map arg0)`
`static void`	`refreshPreferences()` Fetch all the application's preferences and update the PreferenceScope with any new values.
`Object`	`remove(Object arg0)`
`int`	`size()`
`void`	`synchronizePreferencesMap(java.util.HashMap preferences)` Populate the preferences with the specified values.
`java.util.Collection`	`values()`

Methods inherited from class oracle.adfmf.framework.Scope
addPropertyChangeListener, getScopeName, isMissingKeyResolvable, removePropertyChangeListener

Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Constructor Detail
  - PreferenceScope
```
public PreferenceScope()
```
  - PreferenceScope
```
public PreferenceScope(String branchName)
```
- Method Detail
  - getInstance
```
public static final PreferenceScope getInstance()
```
  - refreshPreferences
```
public static void refreshPreferences()
```
    Fetch all the application's preferences and update the PreferenceScope with any new values. Doing this will fire DCEs for all changed preference values.
  - populatePreferencesMap
```
public void populatePreferencesMap(java.util.HashMap preferences)
```
    populate a subset of the preferences map starting at the top
    
    Parameters:
    
    preferences - - flat list of preferences (name-value pairs)
  - synchronizePreferencesMap
```
public void synchronizePreferencesMap(java.util.HashMap preferences)
```
    Populate the preferences with the specified values. Any changes should fire appropriate data change events but these changes should not be sent back to the native side as they are assummed to have already been changed there.
    
    Parameters:
    
    preferences - the preferences to set
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface java.util.Map
    
    Overrides:
    
    get in class oracle.adfmf.framework.Scope
    
    See Also:
    
    Map
  - put
```
public Object put(Object key,
                  Object value)
```
    Specified by:
    
    put in interface java.util.Map
    
    Overrides:
    
    put in class oracle.adfmf.framework.Scope
    
    See Also:
    
    Map
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map
    
    Overrides:
    
    clear in class oracle.adfmf.framework.Scope
    
    See Also:
    
    Map
  - containsKey
```
public boolean containsKey(Object arg0)
```
    Specified by:
    
    containsKey in interface java.util.Map
    
    Overrides:
    
    containsKey in class java.util.HashMap
    
    See Also:
    
    Map
  - containsValue
```
public boolean containsValue(Object arg0)
```
    Specified by:
    
    containsValue in interface java.util.Map
    
    Overrides:
    
    containsValue in class java.util.HashMap
    
    See Also:
    
    Map
  - entrySet
```
public java.util.Set entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map
    
    Overrides:
    
    entrySet in class java.util.HashMap
    
    See Also:
    
    Map
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map
    
    Overrides:
    
    isEmpty in class java.util.HashMap
    
    See Also:
    
    Map
  - keySet
```
public java.util.Set keySet()
```
    Specified by:
    
    keySet in interface java.util.Map
    
    Overrides:
    
    keySet in class java.util.HashMap
    
    See Also:
    
    Map
  - putAll
```
public void putAll(java.util.Map arg0)
```
    Specified by:
    
    putAll in interface java.util.Map
    
    Overrides:
    
    putAll in class java.util.HashMap
    
    See Also:
    
    Map
  - remove
```
public Object remove(Object arg0)
```
    Specified by:
    
    remove in interface java.util.Map
    
    Overrides:
    
    remove in class java.util.HashMap
    
    See Also:
    
    Map
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map
    
    Overrides:
    
    size in class java.util.HashMap
    
    See Also:
    
    Map
  - values
```
public java.util.Collection values()
```
    Specified by:
    
    values in interface java.util.Map
    
    Overrides:
    
    values in class java.util.HashMap
    
    See Also:
    
    Map

Class PreferenceScope

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class oracle.adfmf.framework.Scope

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class Object

Methods inherited from interface java.util.Map

Constructor Detail

PreferenceScope

PreferenceScope

Method Detail

getInstance

refreshPreferences

populatePreferencesMap

synchronizePreferencesMap

get

put

clear

containsKey

containsValue

entrySet

isEmpty

keySet

putAll

remove

size

values