RuleSetUtils (PMD Documentation Generator 6.24.0 API)

java.lang.Object
- net.sourceforge.pmd.docs.RuleSetUtils

public final class RuleSetUtils
extends Object

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static String`	`getRuleSetClasspath(RuleSet ruleset)`
`static String`	`getRuleSetFilename(String rulesetFileName)`
`static String`	`getRuleSetFilename(RuleSet ruleset)`	Gets the sanitized base name of the ruleset.
`static boolean`	`isRuleSetDeprecated(RuleSet ruleset)`	A ruleset is considered deprecated, if it only contains rule references and all rule references are deprecated.
`static Rule`	`resolveRuleReferences(Rule rule)`	Recursively resolves rule references until the last reference.

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

- Method Detail
  - getRuleSetFilename
```
public static String getRuleSetFilename(RuleSet ruleset)
```
    Gets the sanitized base name of the ruleset. For some reason, the filename might contain some newlines, which are removed.
    
    Parameters:
    
    ruleset -
    
    Returns:
  - getRuleSetFilename
```
public static String getRuleSetFilename(String rulesetFileName)
```
  - isRuleSetDeprecated
```
public static boolean isRuleSetDeprecated(RuleSet ruleset)
```
    A ruleset is considered deprecated, if it only contains rule references and all rule references are deprecated.
    
    Parameters:
    
    ruleset -
    
    Returns:
  - getRuleSetClasspath
```
public static String getRuleSetClasspath(RuleSet ruleset)
```
  - resolveRuleReferences
```
public static Rule resolveRuleReferences(Rule rule)
```
    Recursively resolves rule references until the last reference. The last reference is returned. If the given rule not a reference, the rule is returned.
    
    Parameters:
    
    rule -
    
    Returns: