org.springframework.boot

Class DefaultApplicationArguments

  • java.lang.Object
    • org.springframework.boot.DefaultApplicationArguments

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean containsOption(java.lang.String name)
      Return whether the set of option arguments parsed from the arguments contains an option with the given name.
      java.util.List<java.lang.String> getNonOptionArgs()
      Return the collection of non-option arguments parsed.
      java.util.Set<java.lang.String> getOptionNames()
      Return the names of all option arguments.
      java.util.List<java.lang.String> getOptionValues(java.lang.String name)
      Return the collection of values associated with the arguments option having the given name.
      java.lang.String[] getSourceArgs()
      Return the raw unprocessed arguments that were passed to the application.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DefaultApplicationArguments

        public DefaultApplicationArguments(java.lang.String... args)

    • Method Detail

      • getSourceArgs

        public java.lang.String[] getSourceArgs()
        Description copied from interface: ApplicationArguments
        Return the raw unprocessed arguments that were passed to the application.
        Specified by:
        getSourceArgs in interface ApplicationArguments
        Returns:
        the arguments

      • getOptionNames

        public java.util.Set<java.lang.String> getOptionNames()
        Description copied from interface: ApplicationArguments
        Return the names of all option arguments. For example, if the arguments were "--foo=bar --debug" would return the values ["foo", "debug"].
        Specified by:
        getOptionNames in interface ApplicationArguments
        Returns:
        the option names or an empty set

      • containsOption

        public boolean containsOption(java.lang.String name)
        Description copied from interface: ApplicationArguments
        Return whether the set of option arguments parsed from the arguments contains an option with the given name.
        Specified by:
        containsOption in interface ApplicationArguments
        Parameters:
        name - the name to check
        Returns:
        true if the arguments contain an option with the given name

      • getOptionValues

        public java.util.List<java.lang.String> getOptionValues(java.lang.String name)
        Description copied from interface: ApplicationArguments
        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
        Specified by:
        getOptionValues in interface ApplicationArguments
        Parameters:
        name - the name of the option
        Returns:
        a list of option values for the given name

      • getNonOptionArgs

        public java.util.List<java.lang.String> getNonOptionArgs()
        Description copied from interface: ApplicationArguments
        Return the collection of non-option arguments parsed.
        Specified by:
        getNonOptionArgs in interface ApplicationArguments
        Returns:
        the non-option arguments or an empty list