A C D E F G H I N O P R S T U V

A

AbstractArchitectureRulesConfigurationTest - Class in com.seventytwomiles.architecturerules

Abstract class that the users of this library will extend in order to create a unit test that asserts architecture.

AbstractArchitectureRulesConfigurationTest() - Constructor for class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest

Upon instantiation, instances a new Configuration by reading the XML configuration file named architecture-rules.xml (by default) or by reading the XMl file name by the getConfigurationFileName method.

AbstractConfigurationFactory - Class in com.seventytwomiles.architecturerules.configuration

Abstract Factory that provides common functionality for ConfigurationFactory implementations.

AbstractConfigurationFactory() - Constructor for class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

addPackage(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule

Adds a package to the Packages collection.

addRule(Rule) - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Add a new Rule to Configuration.rules

addSource(SourceDirectory) - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

addViolation(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule

Add a new violation to this Rule.

AssertArchitectureTask - Class in com.seventytwomiles.architecturerules.ant

Ant task to assert architecture.

AssertArchitectureTask() - Constructor for class com.seventytwomiles.architecturerules.ant.AssertArchitectureTask

C

ClassPathResource - Class in org.springframework.core.io

These classes are all extracted from the Spring Framework in order to remove the dependency on the Spring library.

ClassPathResource(String) - Constructor for class org.springframework.core.io.ClassPathResource

Create a new ClassPathResource for ClassLoader usage.

ClassPathResource(String, ClassLoader) - Constructor for class org.springframework.core.io.ClassPathResource

Create a new ClassPathResource for ClassLoader usage.

ClassPathResource(String, Class) - Constructor for class org.springframework.core.io.ClassPathResource

Create a new ClassPathResource for Class usage.

ClassPathResource(String, ClassLoader, Class) - Constructor for class org.springframework.core.io.ClassPathResource

Create a new ClassPathResource with optional ClassLoader and Class.

ClassUtils - Class in org.springframework.util

Miscellaneous class utility methods.

ClassUtils() - Constructor for class org.springframework.util.ClassUtils

closeQuietly(InputStream) - Static method in class org.apache.commons.io.FileUtils

Unconditionally close an InputStream.

com.seventytwomiles.architecturerules - package com.seventytwomiles.architecturerules

Root of the architecture-rules code base.

com.seventytwomiles.architecturerules.ant - package com.seventytwomiles.architecturerules.ant

Apache Ant support.

com.seventytwomiles.architecturerules.configuration - package com.seventytwomiles.architecturerules.configuration

This package defines APIs for configuring Architecture-Rules, and classes for building the configuration-time model.

com.seventytwomiles.architecturerules.configuration.xml - package com.seventytwomiles.architecturerules.configuration.xml

XML configuration support.

com.seventytwomiles.architecturerules.domain - package com.seventytwomiles.architecturerules.domain

Model entities.

com.seventytwomiles.architecturerules.exceptions - package com.seventytwomiles.architecturerules.exceptions

Exceptions that the Architecture Rules library may through throughout the course of building the configuration, and executing the rules and cyclic dependency testing.

com.seventytwomiles.architecturerules.services - package com.seventytwomiles.architecturerules.services

Assert that rules are not violated and that cyclic dependencies do not exist.

Configuration - Class in com.seventytwomiles.architecturerules.configuration

An instance of Configuration allows the application to specifiy where the source directories are, what rules to test against and under what conditions should an Exception be thrown.

Configuration() - Constructor for class com.seventytwomiles.architecturerules.configuration.Configuration

ConfigurationFactory - Interface in com.seventytwomiles.architecturerules.configuration

Interface for ConfigurationFactory implementations to adhere to.

copy(InputStream, Writer) - Static method in class org.apache.commons.io.FileUtils

Copy bytes from an InputStream to chars on a Writer using the default character encoding of the platform.

copy(InputStream, Writer, String) - Static method in class org.apache.commons.io.FileUtils

Copy bytes from an InputStream to chars on a Writer using the specified character encoding.

copy(Reader, Writer) - Static method in class org.apache.commons.io.FileUtils

Copy chars from a Reader to a Writer.

copy(Reader, OutputStream) - Static method in class org.apache.commons.io.FileUtils

Copy chars from a Reader to bytes on an OutputStream using the default character encoding of the platform, and calling flush.

CyclicDependencyConfiguration - Class in com.seventytwomiles.architecturerules.domain

Represents the configuration information read from the XML configuration file.

CyclicDependencyConfiguration() - Constructor for class com.seventytwomiles.architecturerules.domain.CyclicDependencyConfiguration

CyclicRedundancyException - Exception in com.seventytwomiles.architecturerules.exceptions

Thrown to indicate that a cyclic redundancy was found.

CyclicRedundancyException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException

CyclicRedundancyException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException

CyclicRedundancyException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException

CyclicRedundancyException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException

CyclicRedundancyException(String, String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.CyclicRedundancyException

Constructs a new CyclicRedundancyException with a generated message containing the given packageName and efferentPackage.

CyclicRedundancyService - Interface in com.seventytwomiles.architecturerules.services

Interface for the CyclicRedundancyService to provide a contract for implementations to adhere to.

CyclicRedundancyServiceImpl - Class in com.seventytwomiles.architecturerules.services

Checks for cyclic redundancy among application packages in the source folders.

CyclicRedundancyServiceImpl(Configuration) - Constructor for class com.seventytwomiles.architecturerules.services.CyclicRedundancyServiceImpl

Constructor instantiates a new CyclicRedundancyService

D

DEFAULT_CONFIGURATION_FILE_NAME - Static variable in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

The default name of the file containing the XML configuration.

DEFAULT_CYCLICAL_DEPENDENCY_CONFIGURATION_VALUE - Static variable in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

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

DEFAULT_NO_PACKAGES_CONFIGURATION_BOOLEAN_VALUE - Static variable in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

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

DependencyConstraintException - Exception in com.seventytwomiles.architecturerules.exceptions

Exception to be thrown when any Rule fails, that is to say, the rule is violoated.

DependencyConstraintException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.DependencyConstraintException

DependencyConstraintException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.DependencyConstraintException

DependencyConstraintException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.DependencyConstraintException

DependencyConstraintException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.DependencyConstraintException

DependencyConstraintException(String, String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.DependencyConstraintException

Reports which Rule was broken, by its id, and what packages that Rule governs.

describe() - Method in class com.seventytwomiles.architecturerules.domain.Rule

Describes the properties of this rule in an xml-like format.

describePackages() - Method in class com.seventytwomiles.architecturerules.domain.Rule

DigesterConfigurationFactory - Class in com.seventytwomiles.architecturerules.configuration.xml

Apache Commons Digester implementation of the ConfigurationFactory

DigesterConfigurationFactory() - Constructor for class com.seventytwomiles.architecturerules.configuration.xml.DigesterConfigurationFactory

DigesterConfigurationFactory(String) - Constructor for class com.seventytwomiles.architecturerules.configuration.xml.DigesterConfigurationFactory

Instantiates a new ConfigurationFactory and processes the configuration found in the File with the given configurationFileName.

doCyclicDependencyTest - Variable in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Weather or not to check for cyclic dependencies.

doCyclicDependencyTest() - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

doCyclicDependencyTest() - Method in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

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

doTests() - Method in class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest

Runs tests that are configured either programmatically, or by the XML configuration file that is loaded.

E

equals(Object) - Method in class com.seventytwomiles.architecturerules.domain.Rule

equals(Object) - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

equals(Object) - Method in class org.springframework.core.io.ClassPathResource

This implementation compares the underlying class path locations.

execute() - Method in class com.seventytwomiles.architecturerules.ant.AssertArchitectureTask

exists() - Method in class org.springframework.core.io.ClassPathResource

This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.

F

FileUtils - Class in org.apache.commons.io

FileUtils utility class extracted from the Spring Framework in order to remove the dependency on Spring for this one class.

FileUtils() - Constructor for class org.apache.commons.io.FileUtils

G

getComment() - Method in class com.seventytwomiles.architecturerules.domain.Rule

Getter for property Rule.comment.

getConfiguration() - Method in class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest

Getter for property AbstractArchitectureRulesConfigurationTest.configuration.

getConfigurationAsXml(String) - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Read Xml configuration file to String.

getConfigurationFileName() - Method in class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest

Get the name of the xml configuration file that is located in the classpath.

getDefaultClassLoader() - Static method in class org.springframework.util.ClassUtils

Return a default ClassLoader to use (never null).

getDescriptionOfRule() - Method in class com.seventytwomiles.architecturerules.domain.Rule

getFile() - Method in class org.springframework.core.io.ClassPathResource

This implementation returns a File reference for the underlying class path resource, provided that it refers to a file in the file system.

getFile(URL, String) - Static method in class org.springframework.util.ResourceUtils

Resolve the given resource URL to a java.io.File, i.e.

getId() - Method in class com.seventytwomiles.architecturerules.domain.Rule

Getter for property Rule.id.

getNoPackages() - Method in class com.seventytwomiles.architecturerules.domain.SourcesConfiguration

Getter for property 'noPackages'.

getPackages() - Method in class com.seventytwomiles.architecturerules.domain.Rule

Getter for property Rule.packages

getPath() - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Getter for property SourceDirectory.path.

getRules() - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Getter for property AbstractConfigurationFactory.rules.

getRules() - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Getter for property Configuration.rules.

getRules() - Method in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

Getter for property //rules.

getRules() - Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration

Getter for property Configuration.rules.

getSources() - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Getter for property AbstractConfigurationFactory.sources.

getSources() - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Getter for property Configuration.sources.

getSources() - Method in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

Getter for property //sources.

getSources() - Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration

Getter for property Configuration.sources.

getTest() - Method in class com.seventytwomiles.architecturerules.domain.CyclicDependencyConfiguration

Getter for property 'test'.

getViolations() - Method in class com.seventytwomiles.architecturerules.domain.Rule

Get all of the violations.

H

hashCode() - Method in class com.seventytwomiles.architecturerules.domain.Rule

hashCode() - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

I

IllegalArchitectureRuleException - Exception in com.seventytwomiles.architecturerules.exceptions

Exception to be thrown when a Rule is illegal constructed.

IllegalArchitectureRuleException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

IllegalArchitectureRuleException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

IllegalArchitectureRuleException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

IllegalArchitectureRuleException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

IllegalArchitectureRuleException(String, String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

Instantiates a new IllegalArchitectureRuleException with the given ruleId and rulePackages.

IllegalArchitectureRuleException(String, String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.IllegalArchitectureRuleException

Instantiates a new IllegalArchitectureRuleException with the given ruleId and rulePackages, and passes on the cause.

InvalidConfigurationException - Exception in com.seventytwomiles.architecturerules.exceptions

RuntimeException that is thrown when a configuration is invalid.

InvalidConfigurationException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.InvalidConfigurationException

InvalidConfigurationException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.InvalidConfigurationException

InvalidConfigurationException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.InvalidConfigurationException

InvalidConfigurationException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.InvalidConfigurationException

N

NoPackagesFoundException - Exception in com.seventytwomiles.architecturerules.exceptions

Exception to be thrown when no packages are found in the given source path if <sources no-packages="exception">

NoPackagesFoundException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException

NoPackagesFoundException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException

NoPackagesFoundException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException

NoPackagesFoundException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException

O

org.apache.commons.io - package org.apache.commons.io

org.springframework.core.io - package org.springframework.core.io

org.springframework.util - package org.springframework.util

P

performCyclicRedundancyCheck() - Method in interface com.seventytwomiles.architecturerules.services.CyclicRedundancyService

Check all the packages in all of the source directories and search for any cyclic redundancy

performCyclicRedundancyCheck() - Method in class com.seventytwomiles.architecturerules.services.CyclicRedundancyServiceImpl

Check all the packages in all of the source directories and search for any cyclic redundancy

performRulesTest() - Method in interface com.seventytwomiles.architecturerules.services.RulesService

Assert that no Rule in the given Configuration has been violated.

performRulesTest() - Method in class com.seventytwomiles.architecturerules.services.RulesServiceImpl

Assert that no Rule in the given Configuration has been violated.

R

readFileToString(File, String) - Static method in class org.apache.commons.io.FileUtils

Reads the contents of a file into a String.

removeViolation(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule

Remove a violation from this Rule.

replaceBackslashForOS(String) - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Replaces inappropriate backslash with the appropriate slash based on the operating system's requirements For example, on a Windows system, src/main/resources becomes src\\main\\resource TODO: this may be able to be replaced with String.replaceAll, but I couldn't get the regex just right

ResourceUtils - Class in org.springframework.util

Utility methods for resolving resource locations to files in the file system.

ResourceUtils() - Constructor for class org.springframework.util.ResourceUtils

Rule - Class in com.seventytwomiles.architecturerules.domain

Represents a Rule that may not be violoated.

Rule() - Constructor for class com.seventytwomiles.architecturerules.domain.Rule

Constructs a new Rule.

Rule(String) - Constructor for class com.seventytwomiles.architecturerules.domain.Rule

Instantiates a new Rule with the given id.

Rule(String, String) - Constructor for class com.seventytwomiles.architecturerules.domain.Rule

Instantiates a new Rule with the given id.

rules - Variable in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Set of Rules read from the configuration file

RulesService - Interface in com.seventytwomiles.architecturerules.services

Interface for RuleService implementations to adhere to.

RulesServiceImpl - Class in com.seventytwomiles.architecturerules.services

Drives the tests by reading the configuration then asserting each defined Rule.

RulesServiceImpl(Configuration) - Constructor for class com.seventytwomiles.architecturerules.services.RulesServiceImpl

Instantiates a new RulesService which will begin reading all the configured sources

S

setComment(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule

Setter for property Rule.comment.

setConfigurationFileName(String) - Method in class com.seventytwomiles.architecturerules.ant.AssertArchitectureTask

Setter for property 'configurationFileName'.

setDoCyclicDependencyTest(boolean) - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Setter for property Configuration.doCyclicDependencyTest.

setDoCyclicDependencyTest(boolean) - Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration

Setter for property Configuration.doCyclicDependencyTest.

setId(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule

Setter for property Rule.id.

setNoPackages(String) - Method in class com.seventytwomiles.architecturerules.domain.SourcesConfiguration

Setter for property 'noPackages'.

setNotFound(String) - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Setter for property 'notFound'.

setPath(String) - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Setter for property SourceDirectory.path.

setShouldThrowExceptionWhenNotFound(boolean) - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Setter for property SourceDirectory.shouldThrowExceptionWhenNotFound.

setTest(String) - Method in class com.seventytwomiles.architecturerules.domain.CyclicDependencyConfiguration

Setter for property 'test'.

setThrowExceptionWhenNoPackages(boolean) - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Setter for property Configuration.throwExceptionWhenNoPackages.

setThrowExceptionWhenNoPackages(boolean) - Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration

Setter for property Configuration.throwExceptionWhenNoPackages.

shouldDoCyclicDependencyTest() - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Getter for property Configuration.doCyclicDependencyTest.

shouldThrowExceptionWhenNoPackages() - Method in class com.seventytwomiles.architecturerules.configuration.Configuration

Getter for property Configuration.throwExceptionWhenNoPackages.

shouldThrowExceptionWhenNotFound() - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

Getter for property SourceDirectory.shouldThrowExceptionWhenNotFound.

SourceDirectory - Class in com.seventytwomiles.architecturerules.domain

Representation of a source directory to search for packages and .class files in.

SourceDirectory() - Constructor for class com.seventytwomiles.architecturerules.domain.SourceDirectory

Instantiates a new SourceDirectory entity.

SourceDirectory(String) - Constructor for class com.seventytwomiles.architecturerules.domain.SourceDirectory

Instantiates a new SourceDirectory with the given path

SourceDirectory(String, boolean) - Constructor for class com.seventytwomiles.architecturerules.domain.SourceDirectory

Instantiates a new SourceDirectory with the given path and shouldThrowExceptionWhenNotFound values

SourceDirectory(String, String) - Constructor for class com.seventytwomiles.architecturerules.domain.SourceDirectory

Instantiates a new SourceDirectory with the given path and notFound values.

SourceNotFoundException - Exception in com.seventytwomiles.architecturerules.exceptions

Exception to be thrown when a configured source is not found and <source not-found="exception">

SourceNotFoundException() - Constructor for exception com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException

SourceNotFoundException(String) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException

SourceNotFoundException(Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException

SourceNotFoundException(Collection) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException

Instantiates a new SourceNotFoundException with a message containing all of the sources that were intteroagated.

SourceNotFoundException(String, Throwable) - Constructor for exception com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException

sources - Variable in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Set of Source read from configuration file

SourcesConfiguration - Class in com.seventytwomiles.architecturerules.domain

Represents the configuration information read from the XML configuration file.

SourcesConfiguration() - Constructor for class com.seventytwomiles.architecturerules.domain.SourcesConfiguration

Instantiate a new SourcesConfiguration

SourcesConfiguration(String) - Constructor for class com.seventytwomiles.architecturerules.domain.SourcesConfiguration

Instantiates a new SourcesConfiguration with the given noPackages value.

T

testArchitecture() - Method in class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest

Implement this method and call AbstractArchitectureRulesConfigurationTest.doTests()

throwExceptionWhenNoPackages - Variable in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Weather or not to throw exception when no packages are found for a given path.

throwExceptionWhenNoPackages() - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

throwExceptionWhenNoPackages() - Method in interface com.seventytwomiles.architecturerules.configuration.ConfigurationFactory

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.

toString() - Method in class com.seventytwomiles.architecturerules.domain.SourceDirectory

toString(InputStream, String) - Static method in class org.apache.commons.io.FileUtils

Get the contents of an InputStream as a String using the specified character encoding.

U

UnmodifiableConfiguration - Class in com.seventytwomiles.architecturerules.configuration

An UnmodifiableConfiguration is a Configuration instance whose setters and collections are unavailable or unmodifiable.

UnmodifiableConfiguration(Configuration) - Constructor for class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration

Instantiates a new unmodifiable configuration class.

V

validateConfiguration(String) - Method in class com.seventytwomiles.architecturerules.configuration.AbstractConfigurationFactory

Validate the configuration.

validateConfiguration(String) - Method in class com.seventytwomiles.architecturerules.configuration.xml.DigesterConfigurationFactory

Validate the configurationXml.

A C D E F G H I N O P R S T U V