Package org.jboss.windup.config

Interface ConfigurationOption

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Collection<?> getAvailableValues()
      Returns an ordered list of available values.
      Object getDefaultValue()
      Default value for this option (if not set by user).
      String getDescription()
      Returns descriptive text that may be more lengthy and descriptive (for example, "Excludes the specified Java packages from Windup's scans").
      String getLabel()
      Return a short amount of descriptive text regarding the option (for example, "Exclude Packages").
      String getName()
      Returns the name of the parameter.
      int getPriority()
      Indicates the "priority" of this option.
      Class<?> getType()
      Returns the datatype for this Option (typically File, String, or List).
      InputType getUIType()
      Returns a type that can be used as a hint to indicate what type of user interface should be presented for this option.
      boolean isRequired()
      Indicates whether or not this option must be specified.
      ValidationResult validate​(Object value)
      Validate the user indicated value and return the result.

    • Method Detail

      • getName

        String getName()
        Returns the name of the parameter. This should be a short name that is suitable for use in a command line parameter (for example, "packages" or "excludePackages").

      • getLabel

        String getLabel()
        Return a short amount of descriptive text regarding the option (for example, "Exclude Packages").

      • getDescription

        String getDescription()
        Returns descriptive text that may be more lengthy and descriptive (for example, "Excludes the specified Java packages from Windup's scans").

      • getType

        Class<?> getType()
        Returns the datatype for this Option (typically File, String, or List).

      • getUIType

        InputType getUIType()
        Returns a type that can be used as a hint to indicate what type of user interface should be presented for this option.

      • isRequired

        boolean isRequired()
        Indicates whether or not this option must be specified.

      • getDefaultValue

        Object getDefaultValue()
        Default value for this option (if not set by user).

      • validate

        ValidationResult validate​(Object value)
        Validate the user indicated value and return the result.

      • getPriority

        int getPriority()
        Indicates the "priority" of this option. Higher values (and therefore higher priority) of this value will result in the item being asked earlier than items with a lower priority value.