Package org.apache.rat.anttasks

Class BaseAntTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.rat.anttasks.BaseAntTask
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
Report
public abstract class BaseAntTask extends org.apache.tools.ant.Task
Generated class to provide Ant support for standard RAT command line options. DO NOT EDIT - GENERATED FILE

  • Field Details

  • Constructor Details

    • BaseAntTask

      protected BaseAntTask()

  • Method Details

    • createName

      public static String createName(String longOpt)

    • unsupportedArgs

      public static List<String> unsupportedArgs()

    • args

      protected List<String> args()
      Gets the list of arguments prepared for the CLI code to parse.
      Returns:
      the List of arguments for the CLI command line.

    • setArg

      protected void setArg(String key, String value)
      Set a key and value into the argument list. Replaces any existing value.
      Parameters:
      key - the key for the map.
      value - the value to set.

    • getArg

      public List<String> getArg(String key)
      Get the list of values for a key.
      Parameters:
      key - the key for the map.
      Returns:
      the list of values for the key or null if not set.

    • addArg

      protected void addArg(String key, String[] value)
      Add values to the key in the argument list. If the key does not exist, adds it.
      Parameters:
      key - the key for the map.
      value - the value to set.

    • addArg

      protected void addArg(String key, String value)
      Add a value to the key in the argument list. If the key does not exist, adds it.
      Parameters:
      key - the key for the map.
      value - the value to set.

    • removeArg

      protected void removeArg(String key)
      Remove a key from the argument list.
      Parameters:
      key - the key to remove from the map.

    • setCopyright

      public void setCopyright(String copyright)
      Deprecated.
      The copyright message to use in the license headers. Deprecated for removal since 0.17: Use --edit-copyright instead.
      Parameters:
      copyright - The value to set

    • setEditCopyright

      public void setEditCopyright(String editCopyright)
      The copyright message to use in the license headers. Usually in the form of "Copyright 2008 Foo". Only valid with editLicense attribute
      Parameters:
      editCopyright - The value to set

    • setForce

      public void setForce(boolean force)
      Deprecated.
      Forces any changes in files to be written directly to the source files (i.e. new files are not created). Deprecated for removal since 0.17: Use --edit-overwrite instead.

    • setEditOverwrite

      public void setEditOverwrite(boolean editOverwrite)
      Forces any changes in files to be written directly to the source files (i.e. new files are not created). Only valid with editLicense attribute

    • setAddLicense

      public void setAddLicense(boolean addLicense)
      Deprecated.
      Add the default license header to any file with an unknown license that is not in the exclusion list. Deprecated for removal since 0.17: Use --edit-license instead.

    • setEditLicense

      public void setEditLicense(boolean editLicense)
      Add the default license header to any file with an unknown license that is not in the exclusion list. By default new files will be created with the license header, to force the modification of existing files use the editOverwrite attribute option.

    • setConfigurationNoDefaults

      public void setConfigurationNoDefaults(boolean configurationNoDefaults)
      Ignore default configuration.

    • setNoDefaultLicenses

      public void setNoDefaultLicenses(boolean noDefaultLicenses)
      Deprecated.
      Ignore default configuration. Deprecated for removal since 0.17: Use --configuration-no-defaults instead.

    • setLicensesApprovedFile

      public void setLicensesApprovedFile(String licensesApprovedFile)
      Name of file containing the approved License IDs.
      Parameters:
      licensesApprovedFile - The value to set

    • setLicenseFamiliesApprovedFile

      public void setLicenseFamiliesApprovedFile(String licenseFamiliesApprovedFile)
      Name of file containing the approved family IDs.
      Parameters:
      licenseFamiliesApprovedFile - The value to set

    • setLicensesDeniedFile

      public void setLicensesDeniedFile(String licensesDeniedFile)
      Name of file containing the denied license IDs.
      Parameters:
      licensesDeniedFile - The value to set

    • setLicenseFamiliesDeniedFile

      public void setLicenseFamiliesDeniedFile(String licenseFamiliesDeniedFile)
      Name of file containing the denied license IDs.
      Parameters:
      licenseFamiliesDeniedFile - The value to set

    • setExcludeFile

      public void setExcludeFile(String excludeFile)
      Deprecated.
      Reads <Expression> entries from a file. Entries will be excluded from processing. Deprecated for removal since 0.17: Use --input-exclude-file instead.
      Parameters:
      excludeFile - The value to set

    • setInputExcludeFile

      public void setInputExcludeFile(String inputExcludeFile)
      Reads <Expression> entries from a file. Entries will be excluded from processing.
      Parameters:
      inputExcludeFile - The value to set

    • setInputExcludeSize

      public void setInputExcludeSize(String inputExcludeSize)
      Excludes files with sizes less than the given argument.
      Parameters:
      inputExcludeSize - The value to set

    • setInputIncludeFile

      public void setInputIncludeFile(String inputIncludeFile)
      Reads <Expression> entries from a file. Entries will override excluded files.
      Parameters:
      inputIncludeFile - The value to set

    • setIncludesFile

      public void setIncludesFile(String includesFile)
      Deprecated.
      Reads <Expression> entries from a file. Entries will be excluded from processing. Deprecated for removal since 0.17: Use --input-include-file instead.
      Parameters:
      includesFile - The value to set

    • setScanHiddenDirectories

      public void setScanHiddenDirectories(boolean scanHiddenDirectories)
      Deprecated.
      Scans hidden directories. Deprecated for removal since 0.17: Use --input-include-std with 'HIDDEN_DIR' argument instead.

    • setOutputStyle

      public void setOutputStyle(String outputStyle)
      XSLT stylesheet to use when creating the report. Either an external xsl file may be specified or one of the internal named sheets.
      Parameters:
      outputStyle - The value to set

    • setStylesheet

      public void setStylesheet(String stylesheet)
      Deprecated.
      XSLT stylesheet to use when creating the report. Deprecated for removal since 0.17: Use --output-style instead.
      Parameters:
      stylesheet - The value to set

    • setXml

      public void setXml(boolean xml)
      Deprecated.
      forces XML output rather than the textual report. Deprecated for removal since 0.17: Use --output-style with the 'xml' argument instead.

    • setOutputLicenses

      public void setOutputLicenses(String outputLicenses)
      List the defined licenses.
      Parameters:
      outputLicenses - The value to set

    • setListLicenses

      public void setListLicenses(String listLicenses)
      Deprecated.
      List the defined licenses. Deprecated for removal since 0.17: Use --output-licenses instead.
      Parameters:
      listLicenses - The value to set

    • setOutputFamilies

      public void setOutputFamilies(String outputFamilies)
      List the defined license families.
      Parameters:
      outputFamilies - The value to set

    • setListFamilies

      public void setListFamilies(String listFamilies)
      Deprecated.
      List the defined license families. Deprecated for removal since 0.17: Use --output-families instead.
      Parameters:
      listFamilies - The value to set

    • setDryRun

      public void setDryRun(boolean dryRun)
      If set do not update the files but generate the reports.

    • setOut

      public void setOut(String out)
      Deprecated.
      Define the output file where to write a report to. Deprecated for removal since 0.17: Use --output-file instead.
      Parameters:
      out - The value to set

    • setOutputFile

      public void setOutputFile(String outputFile)
      Define the output file where to write a report to.
      Parameters:
      outputFile - The value to set

    • setOutputArchive

      public void setOutputArchive(String outputArchive)
      Specifies the level of detail in ARCHIVE file reporting.
      Parameters:
      outputArchive - The value to set

    • setOutputStandard

      public void setOutputStandard(String outputStandard)
      Specifies the level of detail in STANDARD file reporting.
      Parameters:
      outputStandard - The value to set

    • setHelpLicenses

      public void setHelpLicenses(boolean helpLicenses)
      Print information about registered licenses.

    • createConfig

      public BaseAntTask.Config createConfig()
      File names for system configuration.

    • createLicenses

      public BaseAntTask.Licenses createLicenses()
      Deprecated.
      File names for system configuration. Deprecated for removal since 0.17: Use --config instead.

    • createLicensesApproved

      public BaseAntTask.LicensesApproved createLicensesApproved()
      The approved License IDs. These licenses will be added to the list of approved licenses.

    • createLicensesApprovedFile

      public BaseAntTask.LicensesApprovedFile createLicensesApprovedFile()
      Name of file containing the approved License IDs.

    • createLicenseFamiliesApproved

      public BaseAntTask.LicenseFamiliesApproved createLicenseFamiliesApproved()
      The approved License Family IDs. These licenses families will be added to the list of approved licenses families.

    • createLicenseFamiliesApprovedFile

      public BaseAntTask.LicenseFamiliesApprovedFile createLicenseFamiliesApprovedFile()
      Name of file containing the approved family IDs.

    • createLicensesDenied

      public BaseAntTask.LicensesDenied createLicensesDenied()
      The denied License IDs. These licenses will be removed from the list of approved licenses. Once licenses are removed they can not be added back.

    • createLicensesDeniedFile

      public BaseAntTask.LicensesDeniedFile createLicensesDeniedFile()
      Name of file containing the denied license IDs.

    • createLicenseFamiliesDenied

      public BaseAntTask.LicenseFamiliesDenied createLicenseFamiliesDenied()
      The denied License family IDs. These license families will be removed from the list of approved licenses.

    • createLicenseFamiliesDeniedFile

      public BaseAntTask.LicenseFamiliesDeniedFile createLicenseFamiliesDeniedFile()
      Name of file containing the denied license IDs.

    • createCounterMax

      public BaseAntTask.CounterMax createCounterMax()
      The acceptable maximum number for the specified counter. A value of '-1' specifies an unlimited number.

    • createCounterMin

      public BaseAntTask.CounterMin createCounterMin()
      The minimum number for the specified counter.

    • createInputSource

      public BaseAntTask.InputSource createInputSource()
      A file containing file names to process. File names must use linux directory separator ('/') or none at all. File names that do not start with '/' are relative to the directory where the argument is located.

    • createExclude

      public BaseAntTask.Exclude createExclude()
      Deprecated.
      Excludes files matching <Expression>. Deprecated for removal since 0.17: Use --input-exclude instead.

    • createInputExclude

      public BaseAntTask.InputExclude createInputExclude()
      Excludes files matching <Expression>.

    • createExcludeFile

      public BaseAntTask.ExcludeFile createExcludeFile()
      Deprecated.
      Reads <Expression> entries from a file. Entries will be excluded from processing. Deprecated for removal since 0.17: Use --input-exclude-file instead.

    • createInputExcludeFile

      public BaseAntTask.InputExcludeFile createInputExcludeFile()
      Reads <Expression> entries from a file. Entries will be excluded from processing.

    • createInputExcludeStd

      public BaseAntTask.InputExcludeStd createInputExcludeStd()
      Excludes files defined in standard collections based on commonly occurring groups.

    • createInputExcludeSize

      public BaseAntTask.InputExcludeSize createInputExcludeSize()
      Excludes files with sizes less than the given argument.

    • createInputInclude

      public BaseAntTask.InputInclude createInputInclude()
      Includes files matching <Expression>. Will override excluded files.

    • createInclude

      public BaseAntTask.Include createInclude()
      Deprecated.
      Includes files matching <Expression>. Will override excluded files. Deprecated for removal since 0.17: Use --input-include instead.

    • createInputIncludeFile

      public BaseAntTask.InputIncludeFile createInputIncludeFile()
      Reads <Expression> entries from a file. Entries will override excluded files.

    • createIncludesFile

      public BaseAntTask.IncludesFile createIncludesFile()
      Deprecated.
      Reads <Expression> entries from a file. Entries will be excluded from processing. Deprecated for removal since 0.17: Use --input-include-file instead.

    • createInputIncludeStd

      public BaseAntTask.InputIncludeStd createInputIncludeStd()
      Includes files defined in standard collections based on commonly occurring groups. Will override excluded files.

    • createInputExcludeParsedScm

      public BaseAntTask.InputExcludeParsedScm createInputExcludeParsedScm()
      Parse SCM based exclusion files to exclude specified files and directories.

    • createOut

      public BaseAntTask.Out createOut()
      Deprecated.
      Define the output file where to write a report to. Deprecated for removal since 0.17: Use --output-file instead.

    • createOutputFile

      public BaseAntTask.OutputFile createOutputFile()
      Define the output file where to write a report to.