Package com.io7m.jade.api

Interface ApplicationDirectoryConfigurationType

  • All Known Implementing Classes:
    ApplicationDirectoryConfiguration
    @Immutable
public interface ApplicationDirectoryConfigurationType
    The type of application directory configurations.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.lang.String applicationName()
      The name of the application.
      default void checkPreconditions()
      Check preconditions for the type.
      java.util.Optional<java.lang.String> overridePropertyName()
      The name of a system property which, if present, will be used to specify a fixed base directory against which all other application directories will be resolved.
      java.util.Optional<java.lang.String> portablePropertyName()
      The name of a system property which, if present, will be used to enable portable mode.

    • Method Detail

      • applicationName

        java.lang.String applicationName()
        The name of the application. The name is used in paths and must be valid according to ApplicationNames.isValid(String).
        Returns:
        The name of the application.

      • portablePropertyName

        java.util.Optional<java.lang.String> portablePropertyName()
        The name of a system property which, if present, will be used to enable portable mode. If the system property is present, and can be parsed as a true value, then portable mode will be enabled and all calculated application paths will be relative to the application's working directory.
        Returns:
        A property name to enable portable mode

      • overridePropertyName

        java.util.Optional<java.lang.String> overridePropertyName()
        The name of a system property which, if present, will be used to specify a fixed base directory against which all other application directories will be resolved. If the system property is present, the contents will be used directory as the name of a base directory, and all calculated application paths will be relative to this directory. Paths exactly equivalent to those produced by portable mode can be obtained by specifying the application's working directory in the system property.
        Returns:
        A property name to enable portable mode

      • checkPreconditions

        @Check
default void checkPreconditions()
        Check preconditions for the type.