Interface RhythmDirsLocator

All Known Implementing Classes:
RhythmDirsLocatorImpl
public interface RhythmDirsLocator
Provides the location of the rhythm-related directories

  • Field Details

    • DEFAULT_RHYTHMS_SUBDIR

      static final String DEFAULT_RHYTHMS_SUBDIR
      See Also:

    • PROP_RHYTHM_USER_DIRECTORY

      static final String PROP_RHYTHM_USER_DIRECTORY
      A property change event must be fired when rhythm user directory is changed.
      See Also:

  • Method Details

    • getDefault

      static RhythmDirsLocator getDefault()
      Get the default implementation found in the global lookup, or a basic implementation if nothing found.
      Returns:

    • getUserRhythmsDirectory

      File getUserRhythmsDirectory()
      Get the user base directory for Rhythm files.

      Create the directory if required.

      Returns:
      An existing directory

    • setUserRhythmsDirectory

      void setUserRhythmsDirectory(File dir)
      Set the user base directory where to find rhythm files.

      If changed the method fires a PROP_RHYTHM_USER_DIRECTORY property change event.

      Parameters:
      dir - Must exist

    • getDefaultRhythmsDirectory

      default File getDefaultRhythmsDirectory()
      Get the directory for default rhythm files.

      Default implementation returns getUserRhythmsDirectory()/DEFAULT_RHYTHMS_SUBDIR. Create the directory if required.

      Returns:
      An existing directory

    • addPropertyChangeListener

      void addPropertyChangeListener(PropertyChangeListener l)

    • removePropertyChangeListener

      void removePropertyChangeListener(PropertyChangeListener l)