Interface ApplicationArguments

All Known Implementing Classes:
DefaultApplicationArguments

public interface ApplicationArguments
Provides access to the arguments that were used to run a SpringApplication.
Since:
1.3.0
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Return whether the set of option arguments parsed from the arguments contains an option with the given name.
    Return the collection of non-option arguments parsed.
    Return the names of all option arguments.
    Return the collection of values associated with the arguments option having the given name.
    Return the raw unprocessed arguments that were passed to the application.
  • Method Details

    • getSourceArgs

      String[] getSourceArgs()
      Return the raw unprocessed arguments that were passed to the application.
      Returns:
      the arguments
    • getOptionNames

      Set<String> getOptionNames()
      Return the names of all option arguments. For example, if the arguments were "--foo=bar --debug" would return the values ["foo", "debug"].
      Returns:
      the option names or an empty set
    • containsOption

      boolean containsOption(String name)
      Return whether the set of option arguments parsed from the arguments contains an option with the given name.
      Parameters:
      name - the name to check
      Returns:
      true if the arguments contain an option with the given name
    • getOptionValues

      List<String> getOptionValues(String name)
      Return the collection of values associated with the arguments option having the given name.
      • if the option is present and has no argument (e.g.: "--foo"), return an empty collection ([])
      • if the option is present and has a single value (e.g. "--foo=bar"), return a collection having one element (["bar"])
      • if the option is present and has multiple values (e.g. "--foo=bar --foo=baz"), return a collection having elements for each value (["bar", "baz"])
      • if the option is not present, return null
      Parameters:
      name - the name of the option
      Returns:
      a list of option values for the given name
    • getNonOptionArgs

      List<String> getNonOptionArgs()
      Return the collection of non-option arguments parsed.
      Returns:
      the non-option arguments or an empty list