Overview

This class defines a preference property. Objects of this class are immutable. A preference property stores a preference setting for a preference set that can override the setting on another preference set.

The type of a preference property's value may only be one of those listed in . Values of the *_LIST types must be specified as an appropriate java.util.List<java.io.Serializable>. Individual values in *_LIST must be of the same type.

Preference property values may be 1 to 4000 bytes in size.

Preference property naming guidelines

  • Names must use alpha-numeric ASCII characters, dot (.), and underscore (_) characters only and must not include spaces; preference property names may be used as keys in resource bundles for internationalization
  • A name must be in lower-case only
  • A names must indicate potential use
  • Logical portions of names (words) may be dot-separated
  • Words may be separated by a _ (underscore) character
  • A name can be up to 64 characters long; smaller is better
  • Digits can appear only at the end of the property name; for example my.prop.name1 is allowed; my1.prop.name is not allowed
  • The fully qualified name of a preference property should be treated as <set-name>/<property-name> it would thus be redundant to include the preference set name in the property name also
Good examples are
  • sidebar.autohide
  • read_message.delay
  • auto_reply.text1
  • auto_reply.text2
  • auto_reply.mode
  • display.name_format

Members

Name Type Required Description

final

boolean
Whether this property is non-overrideable in preference sets that inherit from this property's preference set.

format

string
Optional format string for the property value.

multiValue

list

name

string
Name of the property.

singleValue

anyType

Hierarchy

Examples

Below are examples in XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:preferenceProperty xsi:type="obh:preferenceProperty" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <final>your_boolean_0</final>
         <format>your_string_0</format>
         <multiValue>your_list_0</multiValue>
         <name>your_string_0</name>
         <singleValue>your_anyType_0</singleValue>
 </obh:preferenceProperty>

Referenced By Representaions