Package de.obqo.decycle.configuration

Class Configuration.ConfigurationBuilder

java.lang.Object

de.obqo.decycle.configuration.Configuration.ConfigurationBuilder

Enclosing class:

Configuration

public static class Configuration.ConfigurationBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
Configuration	build()
Configuration.ConfigurationBuilder	classpath(java.lang.String classpath)
Configuration.ConfigurationBuilder	constraints(java.util.Set<Constraint> constraints)
Configuration.ConfigurationBuilder	excluding(java.util.List<java.lang.String> excluding)
Configuration.ConfigurationBuilder	ignoring(java.util.List<IgnoredDependency> ignoring)
Configuration.ConfigurationBuilder	including(java.util.List<java.lang.String> including)
Configuration.ConfigurationBuilder	minifyReport(java.lang.Boolean minifyReport)
Configuration.ConfigurationBuilder	report(java.lang.Appendable report)
Configuration.ConfigurationBuilder	reportTitle(java.lang.String reportTitle)
Configuration.ConfigurationBuilder	slicings(java.util.Map<java.lang.String,java.util.List<Pattern>> slicings)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

classpath

public Configuration.ConfigurationBuilder classpath(java.lang.String classpath)

Parameters:

classpath - The classpath the be analyzed - this cannot be null or omitted. The classpath is a string of directories or jar files that are separated by the OS specific path separator (typically a semicolon ';' or colon ':').

Returns:

this.

including

public Configuration.ConfigurationBuilder including(java.util.List<java.lang.String> including)

Parameters:

including - Include only classes in the analysis whose fully qualified class names match the given patterns (if null or empty: include all classes) - see PatternMatchingNodeFilter

Returns:

this.

excluding

public Configuration.ConfigurationBuilder excluding(java.util.List<java.lang.String> excluding)

Parameters:

excluding - Exclude classes from the analysis whose fully qualified class names match the given patterns (if null or empty: exclude no classes) - see PatternMatchingNodeFilter

Returns:

this.

ignoring

public Configuration.ConfigurationBuilder ignoring(java.util.List<IgnoredDependency> ignoring)

Parameters:

ignoring - List of class dependencies that should be ignored when checking cycles and other constraints

Returns:

this.

slicings

public Configuration.ConfigurationBuilder slicings(java.util.Map<java.lang.String,java.util.List<Pattern>> slicings)

Parameters:

slicings - Definition of slicings (map key = slicing type, map value = list of patterns that create the slices)

Returns:

this.

constraints

public Configuration.ConfigurationBuilder constraints(java.util.Set<Constraint> constraints)

Parameters:

constraints - Set of additional constraints to be checked (Note: CycleFree is automatically included)

Returns:

this.

report

public Configuration.ConfigurationBuilder report(java.lang.Appendable report)

Parameters:

report - Target of the HTML report (if null, then no report is written)

Returns:

this.

reportTitle

public Configuration.ConfigurationBuilder reportTitle(java.lang.String reportTitle)

Parameters:

reportTitle - HTML Title to be used in the generated report. Has no effect if no report was configured.

Returns:

this.

minifyReport

public Configuration.ConfigurationBuilder minifyReport(java.lang.Boolean minifyReport)

Parameters:

minifyReport - Whether the HTML report should be minified (default is true). Has no effect if no report was configured.

Returns:

this.

build

public Configuration build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object