org.apache.river.tool.classdepend

Class ClassDependParameters.CDPBuilder

java.lang.Object

org.apache.river.tool.classdepend.ClassDependParameters.CDPBuilder

Enclosing class:

ClassDependParameters

public static class ClassDependParameters.CDPBuilder
extends Object

CDPBuilder - to build an immutable ClassDependParameters object, much like the StringBuilder and String class relationship. CDP Builder is not threadsafe. Optional Parameters are set by methods that can be chained on the Builder object, which has a no argument constructor. The build() method returns the new ClassDependParameters object, the builder can be used to build as many ClassDependParameter objects as desired.

Constructor Summary

Constructors

Constructor and Description
CDPBuilder()

Method Summary

Modifier and Type	Method and Description
ClassDependParameters.CDPBuilder	addHidePackage(String hidePackage)
ClassDependParameters.CDPBuilder	addHidePackages(List hidePackages)
ClassDependParameters.CDPBuilder	addHidePackages(String[] hidePackages)
ClassDependParameters.CDPBuilder	addInsidePackage(String insidePackage) Inside packages limit the scope of the dependency search to Classes within these packages.
ClassDependParameters.CDPBuilder	addInsidePackages(List inside)
ClassDependParameters.CDPBuilder	addInsidePackages(String[] insidePackages) Inside packages limit the scope of the dependency search to Classes within these packages.
ClassDependParameters.CDPBuilder	addOutsidePackageOrClass(String outsidePackageOrClass) The package patterns or class names to be excluded from the dependency search results.
ClassDependParameters.CDPBuilder	addOutsidePackagesOrClasses(List excludes)
ClassDependParameters.CDPBuilder	addOutsidePackagesOrClasses(String[] outsidePackagesOrClasses)
ClassDependParameters.CDPBuilder	addShowPackage(String showPackage)
ClassDependParameters.CDPBuilder	addShowPackages(List showPackages)
ClassDependParameters.CDPBuilder	addShowPackages(String[] showPackages)
ClassDependParameters	build() Builds ClassDependParameters immutable object from optional parameters, execute this method last, after setting all optional parameters.
ClassDependParameters.CDPBuilder	edges(boolean e)
ClassDependParameters.CDPBuilder	excludePlatformClasses(boolean b) This optional parameter if true, excludes Java platform classes from the dependency search.
ClassDependParameters.CDPBuilder	ignoreOuterParentClass(boolean b)

Methods inherited from class java.lang.Object

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

Constructor Detail

CDPBuilder

public CDPBuilder()

Method Detail

addOutsidePackageOrClass

public ClassDependParameters.CDPBuilder addOutsidePackageOrClass(String outsidePackageOrClass)

The package patterns or class names to be excluded from the dependency search results.

Parameters:

outsidePackageOrClass - Package pattern or Class to be excluded from dependency checking. A package pattern ending in .* excludes the packages in the package root directory, to decend recursively into and exclude subpackages, the package pattern should end in .**

Returns:

CDPBuilder so named optional parameters can be chained

See Also:

ClassDepend, ClassDependParameters

addOutsidePackagesOrClasses

public ClassDependParameters.CDPBuilder addOutsidePackagesOrClasses(String[] outsidePackagesOrClasses)

addOutsidePackagesOrClasses

public ClassDependParameters.CDPBuilder addOutsidePackagesOrClasses(List excludes)

addInsidePackage

public ClassDependParameters.CDPBuilder addInsidePackage(String insidePackage)

Inside packages limit the scope of the dependency search to Classes within these packages.

Parameters:

insidePackage - A String pattern including the fully qualified package name, followed by .* to capture classes in the packages root directory or by .** to include subpackages recursively as well.

Returns:

CDPBuilder - enables optional parameter method chaining.

addInsidePackages

public ClassDependParameters.CDPBuilder addInsidePackages(String[] insidePackages)

Inside packages limit the scope of the dependency search to Classes within these packages.

Parameters:

insidePackages -

Returns:

CDPBuilder - enables optional parameter method chaining.

addInsidePackages

public ClassDependParameters.CDPBuilder addInsidePackages(List inside)

addShowPackages

public ClassDependParameters.CDPBuilder addShowPackages(String[] showPackages)

addShowPackages

public ClassDependParameters.CDPBuilder addShowPackages(List showPackages)

addShowPackage

public ClassDependParameters.CDPBuilder addShowPackage(String showPackage)

addHidePackages

public ClassDependParameters.CDPBuilder addHidePackages(String[] hidePackages)

addHidePackages

public ClassDependParameters.CDPBuilder addHidePackages(List hidePackages)

addHidePackage

public ClassDependParameters.CDPBuilder addHidePackage(String hidePackage)

ignoreOuterParentClass

public ClassDependParameters.CDPBuilder ignoreOuterParentClass(boolean b)

excludePlatformClasses

public ClassDependParameters.CDPBuilder excludePlatformClasses(boolean b)

This optional parameter if true, excludes Java platform classes from the dependency search. If false the platform classes returned will depend on the Java platform and version the test is executing on.

Parameters:

b -

Returns:

CDPBuilder - enables optional parameter method chaining.

See Also:

ClassDepend, ClassDependParameters

edges

public ClassDependParameters.CDPBuilder edges(boolean e)

build

public ClassDependParameters build()

Builds ClassDependParameters immutable object from optional parameters, execute this method last, after setting all optional parameters.

Returns:

ClassDependParameter object

See Also:

ClassDependParameters