Package jmri.util.prefs

Class JmriConfiguration

java.lang.Object
jmri.util.prefs.JmriConfiguration
All Implemented Interfaces:
AuxiliaryConfiguration
public abstract class JmriConfiguration extends Object implements AuxiliaryConfiguration

  • Constructor Details

  • Method Details

    • getConfigurationFile

      protected abstract File getConfigurationFile(boolean shared)

    • isSharedBackedUp

      protected abstract boolean isSharedBackedUp()

    • setSharedBackedUp

      protected abstract void setSharedBackedUp(boolean backedUp)

    • isPrivateBackedUp

      protected abstract boolean isPrivateBackedUp()

    • setPrivateBackedUp

      protected abstract void setPrivateBackedUp(boolean backedUp)

    • getConfigurationFragment

      public Element getConfigurationFragment(String elementName, String namespace, boolean shared)
      Description copied from interface: AuxiliaryConfiguration
      Get a configuration fragment as an XML element.

      Multiple elements in a configuration file can have the same name as long as they have different namespaces. If using versioned namespaces, this would allow two different versions of JMRI with incompatible preferences for a given element to use the same name without stomping on each other.

      Note: Use JDOMUtil.toJDOMElement(org.w3c.dom.Element) to convert a non-null result to a JDOM Element.

      Specified by:
      getConfigurationFragment in interface AuxiliaryConfiguration
      Parameters:
      elementName - the name of the element.
      namespace - the namespace of the element.
      shared - true if the fragment is for all computers using this profile, false if the fragment is for just the current computer.
      Returns:
      the matching Element or null if a matching element cannot be found.

    • putConfigurationFragment

      public void putConfigurationFragment(Element fragment, boolean shared) throws IllegalArgumentException
      Description copied from interface: AuxiliaryConfiguration
      Store a configuration fragement as an XML element.

      Multiple elements in a configuration file can have the same name as long as they have different namespaces. If using versioned namespaces, this would allow two different versions of JMRI with incompatible preferences for a given element to use the same name without stomping on each other.

      Note: Use JDOMUtil.toW3CElement(org.jdom2.Element) to convert a JDOM Element to a W3C Element. The JDOM element must have a namespace associated with it.

      Specified by:
      putConfigurationFragment in interface AuxiliaryConfiguration
      Parameters:
      fragment - the XML element. It must have a valid namespace property.
      shared - true if the fragment is for all computers using this profile, false if the fragment is for just the current computer.
      Throws:
      IllegalArgumentException

    • removeConfigurationFragment

      public boolean removeConfigurationFragment(String elementName, String namespace, boolean shared) throws IllegalArgumentException
      Description copied from interface: AuxiliaryConfiguration
      Remove a configuration fragment from the configuration.

      Multiple elements in a configuration file can have the same name as long as they have different namespaces. If using versioned namespaces, this would allow two different versions of JMRI with incompatible preferences for a given element to use the same name without stomping on each other.

      Specified by:
      removeConfigurationFragment in interface AuxiliaryConfiguration
      Parameters:
      elementName - the name of the element.
      namespace - the namespace of the element.
      shared - true if the fragment is for all computers using this profile, false if the fragment is for just the current computer.
      Returns:
      true if the fragment could be removed, false otherwise.
      Throws:
      IllegalArgumentException