org.apache.rat.mp.util

Class ScmIgnoreParser

java.lang.Object

org.apache.rat.mp.util.ScmIgnoreParser

public final class ScmIgnoreParser
extends Object

Helper to parse SCM ignore files to add entries as excludes during RAT runs. Since we log errors it needs to reside inside of the maven plugin.

Method Summary

Modifier and Type	Method and Description
static List<String>	getExcludesFromFile(org.apache.maven.plugin.logging.Log log, File scmIgnore) Parses excludes from the given SCM ignore file.
static List<String>	getExclusionsFromSCM(org.apache.maven.plugin.logging.Log log, File baseDir) Parse ignore files from all known SCMs that have ignore files.

Methods inherited from class java.lang.Object

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

Method Detail

getExcludesFromFile

public static List<String> getExcludesFromFile(org.apache.maven.plugin.logging.Log log,
                                               File scmIgnore)

Parses excludes from the given SCM ignore file.

Parameters:

log - Maven log to show output during RAT runs.

scmIgnore - if null or invalid an empty list of exclusions is returned.

Returns:

all exclusions (=non-comment lines) from the SCM ignore file.

getExclusionsFromSCM

public static List<String> getExclusionsFromSCM(org.apache.maven.plugin.logging.Log log,
                                                File baseDir)

Parse ignore files from all known SCMs that have ignore files.

Parameters:

log - Show information via maven logger.

baseDir - base directory from which to look for SCM ignores.

Returns:

Exclusions from the SCM ignore files.