Package org.apache.rat.tools

Class AntOption

java.lang.Object
org.apache.rat.tools.AbstractOption
org.apache.rat.tools.AntOption
public class AntOption extends AbstractOption
A class that wraps the CLI option and provides Ant specific values.

  • Constructor Details

    • AntOption

      public AntOption(org.apache.commons.cli.Option option)
      Constructor.
      Parameters:
      option - the option to wrap.

  • Method Details

    • getUnsupportedOptions

      public static List<org.apache.commons.cli.Option> getUnsupportedOptions()
      Gets the list of unsupported options.
      Returns:
      The list of unsupported options.

    • getFilteredOptions

      public static Set<org.apache.commons.cli.Option> getFilteredOptions()
      Gets the set of options that are not supported by Ant either by not being supported or by being converted to another argument.
      Returns:
      The set of options that are not supported by Ant.

    • isAttribute

      public boolean isAttribute()
      Returns true if the option should be an attribute of the <rat:report> element.
      Returns:
      true if the option should be an attribute of the <rat:report> element.

    • isElement

      public boolean isElement()
      Returns true if the option should be a child element of the <rat:report> element.
      Returns:
      true if the option should be a child element of the <rat:report> element.

    • getActualAntOption

      public AntOption getActualAntOption()
      If this option is converted to another option return that option otherwise return this option.
      Returns:
      the converted option.

    • convertedFrom

      public Set<org.apache.commons.cli.Option> convertedFrom()
      Gets the set of options that are mapped to this option.
      Returns:
      the set of options that are mapped to this option.

    • cleanupName

      protected String cleanupName(org.apache.commons.cli.Option option)
      Specified by:
      cleanupName in class AbstractOption

    • getComment

      public String getComment(boolean addParam)
      Get the method comment for this option.
      Parameters:
      addParam - if true the param annotation is added.
      Returns:
      the Comment block for the function.

    • getAttributeFunctionName

      public String getAttributeFunctionName()
      Get the signature of the attribute function.
      Returns:
      the signature of the attribute function.

    • getExample

      public String getExample()
      Description copied from class: AbstractOption
      Gets an example of how to use this option in the native UI.
      Specified by:
      getExample in class AbstractOption
      Returns:
      An example of how to use this option in the native UI.