com.seventytwomiles.architecturerules.configuration
Interface ConfigurationFactory

All Known Implementing Classes:

AbstractConfigurationFactory, DigesterConfigurationFactory

public interface ConfigurationFactory

Interface for ConfigurationFactory implementations to adhere to.

Author:

mikenereson

Field Summary

static String	DEFAULT_CONFIGURATION_FILE_NAME The default name of the file containing the XML configuration.
static String	DEFAULT_CYCLICAL_DEPENDENCY_CONFIGURATION_VALUE Holds the default value that should be used when no configuration is entered into the XML configuration file for the cyclic dependency test.
static boolean	DEFAULT_NO_PACKAGES_CONFIGURATION_BOOLEAN_VALUE Holds the default value that should be used when no configuration is entered into the XML configuration file for the no packages attribute.

Method Summary

boolean	doCyclicDependencyTest() Holds the value parsed from the XML configuration that indicates weather or not the cyclic dependency test should be run.
Collection<Rule>	getRules() Getter for property //rules.
List<SourceDirectory>	getSources() Getter for property //sources.
boolean	throwExceptionWhenNoPackages() Holds the value parsed from the XML configuration that indicates weather or not a NoPackagesFoundException should be thrown when no packages are found in any of the given source paths.

Field Detail

DEFAULT_CYCLICAL_DEPENDENCY_CONFIGURATION_VALUE

static final String DEFAULT_CYCLICAL_DEPENDENCY_CONFIGURATION_VALUE

Holds the default value that should be used when no configuration is entered into the XML configuration file for the cyclic dependency test.

See Also:

Constant Field Values

DEFAULT_NO_PACKAGES_CONFIGURATION_BOOLEAN_VALUE

static final boolean DEFAULT_NO_PACKAGES_CONFIGURATION_BOOLEAN_VALUE

Holds the default value that should be used when no configuration is entered into the XML configuration file for the no packages attribute.

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_FILE_NAME

static final String DEFAULT_CONFIGURATION_FILE_NAME

The default name of the file containing the XML configuration.

See Also:

Constant Field Values

Method Detail

doCyclicDependencyTest

boolean doCyclicDependencyTest()

Holds the value parsed from the XML configuration that indicates weather or not the cyclic dependency test should be run.

Returns:

boolean true when <cyclicalDependency test="true"/>

getRules

Collection<Rule> getRules()

Getter for property //rules.

Returns:

Value for property rules.

getSources

List<SourceDirectory> getSources()

Getter for property //sources.

Returns:

Value for property sources.

throwExceptionWhenNoPackages

boolean throwExceptionWhenNoPackages()

Holds the value parsed from the XML configuration that indicates weather or not a NoPackagesFoundException should be thrown when no packages are found in any of the given source paths.

Returns:

boolean true when <sources no-packages="exception">