Class PreferencesObject

java.lang.Object
com.codename1.properties.PreferencesObject
public final class PreferencesObject extends Object
Binds an object to the com.codename1.io.Preferences API for automatic persistent storage. You can use this API like the builder pattern by using the create method and chaining it with setters until bind is invoked.

  • Method Summary

    Modifier and Type
    Method
    Description
    PreferencesObject
    bind()
    Binds the object so it's seamlessly stored in preferences
    static PreferencesObject
    create(PropertyBusinessObject bo)
    Creates a binding object, this method doesn't do anything until bind is invoked
    PreferencesObject
    setName(PropertyBase pb, String name)
    Sets the name of the specific field not including the prefix, by default the property name is used
    PreferencesObject
    setPrefix(String prefix)
    Sets the prefix for the binding, by default the object name with a "." is the common prefix

    Methods inherited from class Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
     
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    final Class
    getClass()
    Returns the runtime class of an object.
    int
    hashCode()
    Returns a hash code value for the object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes current thread to wait until another thread invokes the method or the method for this object.
    final void
    wait(long timeout)
    Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
    final void
    wait(long timeout, int nanos)
    Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

  • Method Details

    • create

      public static PreferencesObject create(PropertyBusinessObject bo)

      Creates a binding object, this method doesn't do anything until bind is invoked

      Parameters
      • bo: the business object this binding relates to
      Returns

      the object controlling the binding

    • bind

      public PreferencesObject bind()

      Binds the object so it's seamlessly stored in preferences

      Returns

      this to enable builder pattern binding

    • setPrefix

      public PreferencesObject setPrefix(String prefix)

      Sets the prefix for the binding, by default the object name with a "." is the common prefix

      Parameters
      • prefix: a string that will prefix the name
      Returns

      this to enable builder pattern binding

    • setName

      public PreferencesObject setName(PropertyBase pb, String name)

      Sets the name of the specific field not including the prefix, by default the property name is used

      Parameters

      • pb: the property

      • name: the name for the property

      Returns

      this to enable builder pattern binding