RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.pmd-code.org/apidocs/pmd-core/6.55.0/net/sourceforge/pmd/PMD.html below:

PMD (PMD Core 6.55.0 API)

- Field Detail
  - EOL
```
@Deprecated
public static final String EOL
```
    The line delimiter used by PMD in outputs. Usually the platform specific line separator.
  - SUPPRESS_MARKER
```
@Deprecated
public static final String SUPPRESS_MARKER
```
    The default suppress marker string.
    
    See Also:
    
    Constant Field Values
  - configuration
```
@Deprecated
protected final PMDConfiguration configuration
```
    Contains the configuration with which this PMD instance has been created.
  - VERSION
```
@Deprecated
public static final String VERSION
```
    Constant that contains always the current version of PMD.
- Constructor Detail
  - PMD
```
@Deprecated
public PMD()
```
    Create a PMD instance using a default Configuration. Changes to the configuration may be required.
  - PMD
```
@Deprecated
public PMD(PMDConfiguration configuration)
```
    Create a PMD instance using the specified Configuration.
    
    Parameters:
    
    configuration - The runtime Configuration of PMD to use.
- Method Detail
  - getURIDataSources
```
@Deprecated
public static List<DataSource> getURIDataSources(String uriString)
                                          throws PMDException
```
    Parses the given string as a database uri and returns a list of datasources.
    
    Parameters:
    
    uriString - the URI to parse
    
    Returns:
    
    list of data sources
    
    Throws:
    
    PMDException - if the URI couldn't be parsed
    
    See Also:
    
    DBURI
  - parserFor
```
@Deprecated
@InternalApi
public static Parser parserFor(LanguageVersion languageVersion,
                               PMDConfiguration configuration)
```
    Helper method to get a configured parser for the requested language. The parser is configured based on the given
    PMDConfiguration
    .
    
    Parameters:
    
    languageVersion - the requested language
    
    configuration - the given configuration
    
    Returns:
    
    the pre-configured parser
  - getConfiguration
```
@Deprecated
public PMDConfiguration getConfiguration()
```
    Get the runtime configuration. The configuration can be modified to affect how PMD behaves.
    
    Returns:
    
    The configuration.
    
    See Also:
    
    PMDConfiguration
  - getSourceCodeProcessor
```
@Deprecated
public SourceCodeProcessor getSourceCodeProcessor()
```
    Gets the source code processor.
    
    Returns:
    
    SourceCodeProcessor
  - doPMD
```
@Deprecated
@InternalApi
public static int doPMD(PMDConfiguration configuration)
```
    This method is the main entry point for command line usage.
    
    Parameters:
    
    configuration - the configuration to use
    
    Returns:
    
    number of violations found. Returns -1 in case of error.
  - newRuleContext
```
@Deprecated
public static RuleContext newRuleContext(String sourceCodeFilename,
                                         File sourceCodeFile)
```
    Creates a new rule context, initialized with a new, empty report.
    
    Parameters:
    
    sourceCodeFilename - the source code filename
    
    sourceCodeFile - the source code file
    
    Returns:
    
    the rule context
  - processFiles
```
@Deprecated
public static void processFiles(PMDConfiguration configuration,
                                RuleSetFactory ruleSetFactory,
                                List<DataSource> files,
                                RuleContext ctx,
                                List<Renderer> renderers)
```
    Run PMD on a list of files using multiple threads - if more than one is available
    
    Parameters:
    
    configuration - Configuration
    
    ruleSetFactory - RuleSetFactory
    
    files - List of DataSources
    
    ctx - RuleContext
    
    renderers - List of Renderers
  - processFiles
```
@Deprecated
public static Report processFiles(PMDConfiguration configuration,
                                  List<RuleSet> rulesets,
                                  Collection<? extends DataSource> files,
                                  List<Renderer> renderers)
```
    Run PMD using the given configuration. This replaces the other overload.
    
    Parameters:
    
    configuration - Configuration for the run. Note that the files, and rulesets, are ignored, as they are supplied as parameters
    
    rulesets - Parsed rulesets
    
    files - Files to process, will be closed by this method.
    
    renderers - Renderers that render the report
    
    Returns:
    
    Report in which violations are accumulated
    
    Throws:
    
    RuntimeException - If processing fails
  - getApplicableFiles
```
@Deprecated
public static List<DataSource> getApplicableFiles(PMDConfiguration configuration,
                                                  Set<Language> languages)
```
    Determines all the files, that should be analyzed by PMD.
    
    Parameters:
    
    configuration - contains either the file path or the DB URI, from where to load the files
    
    languages - used to filter by file extension
    
    Returns:
    
    List of DataSource of files
  - main
```
public static void main(String[] args)
```
    Deprecated.
    
    Entry to invoke PMD as command line tool. Note that this will invoke
    System.exit(int)
    .
    
    Parameters:
    
    args - command line arguments
  - run
```
@Deprecated
public static int run(String[] args)
```
    Parses the command line arguments and executes PMD. Returns the exit code without exiting the VM.
    
    Parameters:
    
    args - command line arguments
    
    Returns:
    
    the exit code, where 0 means successful execution, 1 means error, 4 means there have been violations found.
  - runPmd
```
public static PMD.StatusCode runPmd(String... args)
```
    Deprecated.
    
    Parses the command line arguments and executes PMD. Returns the status code without exiting the VM. Note that the arguments parsing may itself fail and produce a
    PMD.StatusCode.ERROR
    . This will print the error message to standard error.
    
    Parameters:
    
    args - command line arguments
    
    Returns:
    
    the status code. Note that PMDConfiguration.isFailOnViolation() (flag --failOnViolation) may turn an PMD.StatusCode.OK into a PMD.StatusCode.VIOLATIONS_FOUND.
  - runPmd
```
public static PMD.StatusCode runPmd(PMDConfiguration configuration)
```
    Deprecated.
    
    Execute PMD from a configuration. Returns the status code without exiting the VM. This is the main entry point to run a full PMD run with a manually created configuration.
    
    Parameters:
    
    configuration - Configuration to run
    
    Returns:
    
    the status code. Note that PMDConfiguration.isFailOnViolation() (flag --failOnViolation) may turn an PMD.StatusCode.OK into a PMD.StatusCode.VIOLATIONS_FOUND.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4