java.lang.Object
- net.sourceforge.pmd.cli.PMDParameters

public class PMDParameters
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PMDParameters.PropertyConverter`
`static class`	`PMDParameters.RulePriorityConverter`	Deprecated. Will be removed in 7.0.0
`static class`	`PMDParameters.RulePriorityValidator`

Constructor Summary

Constructors
Constructor Description

PMDParameters()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getAuxclasspath()`
`String`	`getEncoding()`
`String`	`getFileListPath()`
`String`	`getFormat()`
`String`	`getIgnoreListPath()`
`String`	`getLanguage()`
`RulePriority`	`getMinimumPriority()`
`Properties`	`getProperties()`
`String`	`getReportfile()`
`String`	`getRulesets()`
`String`	`getSourceDir()`
`String`	`getSuppressmarker()`
`Integer`	`getThreads()`
`String`	`getUri()`
`String`	`getVersion()`
`boolean`	`isBenchmark()`
`boolean`	`isDebug()`
`boolean`	`isFailOnViolation()`
`boolean`	`isHelp()`
`boolean`	`isIgnoreIncrementalAnalysis()`
`boolean`	`isShortnames()`
`boolean`	`isShowsuppressed()`
`boolean`	`isStress()`
`void`	`setUri(String uri)`
`PMDConfiguration`	`toConfiguration()`	Converts these parameters into a configuration.
`static PMDConfiguration`	`transformParametersIntoConfiguration(PMDParameters params)`	Deprecated. To be removed in 7.0.0.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PMDParameters
```
public PMDParameters()
```

Method Detail

toConfiguration
```
public PMDConfiguration toConfiguration()
```
Converts these parameters into a configuration.

Returns:

A new PMDConfiguration corresponding to these parameters

Throws:

IllegalArgumentException - if the parameters are inconsistent or incomplete

isIgnoreIncrementalAnalysis

public boolean isIgnoreIncrementalAnalysis()

transformParametersIntoConfiguration
```
@Deprecated
public static PMDConfiguration transformParametersIntoConfiguration(PMDParameters params)
```
Deprecated.
To be removed in 7.0.0. Use the instance method toConfiguration().

toConfiguration().

isDebug
```
public boolean isDebug()
```

isHelp
```
public boolean isHelp()
```

getEncoding
```
public String getEncoding()
```

getThreads
```
public Integer getThreads()
```

isBenchmark
```
public boolean isBenchmark()
```

isStress
```
public boolean isStress()
```

isShortnames
```
public boolean isShortnames()
```

isShowsuppressed
```
public boolean isShowsuppressed()
```

getSuppressmarker
```
public String getSuppressmarker()
```

getMinimumPriority

public RulePriority getMinimumPriority()

getProperties
```
public Properties getProperties()
```

getReportfile
```
public String getReportfile()
```

getVersion
```
public String getVersion()
```

getLanguage
```
public String getLanguage()
```

getAuxclasspath
```
public String getAuxclasspath()
```

getRulesets
```
public String getRulesets()
```

getSourceDir
```
public String getSourceDir()
```

getFileListPath
```
public String getFileListPath()
```

getIgnoreListPath
```
public String getIgnoreListPath()
```

getFormat
```
public String getFormat()
```

isFailOnViolation
```
public boolean isFailOnViolation()
```

getUri
```
public String getUri()
```
Returns:

the uri alternative to source directory.

setUri
```
public void setUri(String uri)
```
Parameters:

uri - the uri specifying the source directory.

Class PMDParameters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PMDParameters

Method Detail

toConfiguration

isIgnoreIncrementalAnalysis

transformParametersIntoConfiguration

isDebug

isHelp

getEncoding

getThreads

isBenchmark

isStress

isShortnames

isShowsuppressed

getSuppressmarker

getMinimumPriority

getProperties

getReportfile

getVersion

getLanguage

getAuxclasspath

getRulesets

getSourceDir

getFileListPath

getIgnoreListPath

getFormat

isFailOnViolation

getUri

setUri