Class ApplicationHome

java.lang.Object
org.springframework.boot.system.ApplicationHome
public class ApplicationHome extends Object
Provides access to the application home directory. Attempts to pick a sensible home for both Jar Files, Exploded Archives and directly running applications.
Since:
2.0.0
Author:
Phillip Webb, Raja Kolli

  • Constructor Details

    • ApplicationHome

      public ApplicationHome()
      Create a new ApplicationHome instance.

    • ApplicationHome

      public ApplicationHome(@Nullable Class<?> sourceClass)
      Create a new ApplicationHome instance for the specified source class.
      Parameters:
      sourceClass - the source class or null

  • Method Details

    • getSource

      public @Nullable File getSource()
      Returns the underlying source used to find the home directory. This is usually the jar file or a directory. Can return null if the source cannot be determined.
      Returns:
      the underlying source or null

    • getSourcePath

      public @Nullable Path getSourcePath()
      Returns the path of the underlying source used to find the home directory. This is usually the jar file or a directory. Can return null if the source cannot be determined.
      Returns:
      the underlying source path or null
      Since:
      4.2.0

    • getDir

      public File getDir()
      Returns the application home directory.
      Returns:
      the home directory (never null)

    • getPath

      public Path getPath()
      Returns the path of the application home directory.
      Returns:
      the home path (never null)
      Since:
      4.2.0

    • toString

      public String toString()
      Overrides:
      toString in class Object