Package com.parasoft.findings.jenkins.internal.rules

Class RuleDocumentationReader

java.lang.Object

com.parasoft.findings.jenkins.internal.rules.RuleDocumentationReader

public class RuleDocumentationReader
extends Object

Constructor Summary

Constructors

Constructor	Description
RuleDocumentationReader(File buildRoot)
RuleDocumentationReader(File buildRoot, String rulesDocDir)

Method Summary

Modifier and Type	Method	Description
String	getRuleDoc(String analyzer, String ruleId)
static String	getRuleDocKey(String analyzer, String ruleId)
static String	getRuleDocRelativePath(String rulesDocDir, String analyzer, String ruleId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleDocumentationReader

public RuleDocumentationReader(File buildRoot)

RuleDocumentationReader

public RuleDocumentationReader(File buildRoot,
                               String rulesDocDir)

Method Detail

getRuleDoc

public String getRuleDoc(String analyzer,
                         String ruleId)

getRuleDocRelativePath

public static String getRuleDocRelativePath(String rulesDocDir,
                                            String analyzer,
                                            String ruleId)

getRuleDocKey

public static String getRuleDocKey(String analyzer,
                                   String ruleId)