Interface Platform

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean dataDirPreserveCase()
      Check if case is preserved
      boolean dataDirReplaceColon()
      Check if colon is replaced
      boolean dataDirReplaceWhitespace()
      Check if whitespace is replaced
      java.io.File getApplicationDataDir()
      Returns the directory in which Aduna applications can store their application-dependent data, returns 'getOSApplicationDataDir' unless the system property "aduna.platform.applicationdata.dir" has been set.
      java.io.File getApplicationDataDir​(java.lang.String applicationName)
      Returns the directory in which a specific application can store all its application-dependent data.
      java.lang.String getName()
      Get a descriptive name for this platform.
      java.io.File getOSApplicationDataDir()
      Returns the operating system dependent application data directory.
      java.io.File getOSApplicationDataDir​(java.lang.String applicationName)
      Returns the operating system dependent application data directory.
      java.lang.String getRelativeApplicationDataDir​(java.lang.String applicationName)
      Get the directory relative to getApplicationDataDir() for the specified application.
      java.io.File getUserHome()
      Returns the directory for the current user.
    • Field Detail

      • APPDATA_BASEDIR_PROPERTY

        static final java.lang.String APPDATA_BASEDIR_PROPERTY
        See Also:
        Constant Field Values
      • OLD_DATADIR_PROPERTY

        @Deprecated
        static final java.lang.String OLD_DATADIR_PROPERTY
        Deprecated.
        See Also:
        Constant Field Values
    • Method Detail

      • getName

        java.lang.String getName()
        Get a descriptive name for this platform.
        Returns:
        name of the platform
      • getOSApplicationDataDir

        java.io.File getOSApplicationDataDir()
        Returns the operating system dependent application data directory.
        Returns:
        application directory
      • getOSApplicationDataDir

        java.io.File getOSApplicationDataDir​(java.lang.String applicationName)
        Returns the operating system dependent application data directory. This will be a sub-directory of the directory returned by the no-argument version of this method.
        Parameters:
        applicationName - name of the application
        Returns:
        application directory
      • getUserHome

        java.io.File getUserHome()
        Returns the directory for the current user.
        Returns:
        the current user home directory
      • getApplicationDataDir

        java.io.File getApplicationDataDir()
        Returns the directory in which Aduna applications can store their application-dependent data, returns 'getOSApplicationDataDir' unless the system property "aduna.platform.applicationdata.dir" has been set.
        Returns:
        the Aduna-specific application data directory
      • getApplicationDataDir

        java.io.File getApplicationDataDir​(java.lang.String applicationName)
        Returns the directory in which a specific application can store all its application-dependent data. This will be a sub-directory of the directory returned by the no-argument version of this method. Note: the directory might not exist yet.
        Parameters:
        applicationName - the name of the application for which to determine the directory
        Returns:
        an application-specific data directory
        See Also:
        getApplicationDataDir()
      • getRelativeApplicationDataDir

        java.lang.String getRelativeApplicationDataDir​(java.lang.String applicationName)
        Get the directory relative to getApplicationDataDir() for the specified application.
        Parameters:
        applicationName - the name of the application
        Returns:
        the directory relative to getApplicationDataDir() for the specified application
      • dataDirPreserveCase

        boolean dataDirPreserveCase()
        Check if case is preserved
        Returns:
        boolean
      • dataDirReplaceWhitespace

        boolean dataDirReplaceWhitespace()
        Check if whitespace is replaced
        Returns:
        boolean
      • dataDirReplaceColon

        boolean dataDirReplaceColon()
        Check if colon is replaced
        Returns:
        boolean