Index (architecture-rules 2.0.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

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
AbstractConfigurationFactory - Class in com.seventytwomiles.architecturerules.configuration.xml: Abstract Factory that provides common functionality for ConfigurationFactory implementations.
AbstractConfigurationFactory() - Constructor for class com.seventytwomiles.architecturerules.configuration.xml.AbstractConfigurationFactory
addPackage(String) - Method in class com.seventytwomiles.architecturerules.domain.Rule
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
com.seventytwomiles.architecturerules.ant - package com.seventytwomiles.architecturerules.ant
com.seventytwomiles.architecturerules.configuration - package com.seventytwomiles.architecturerules.configuration
com.seventytwomiles.architecturerules.configuration.xml - package com.seventytwomiles.architecturerules.configuration.xml
com.seventytwomiles.architecturerules.domain - package com.seventytwomiles.architecturerules.domain
com.seventytwomiles.architecturerules.exceptions - package com.seventytwomiles.architecturerules.exceptions
com.seventytwomiles.architecturerules.services - package com.seventytwomiles.architecturerules.services
Configuration - Class in com.seventytwomiles.architecturerules.configuration: An instance of Configuration allows the applicaiton 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.xml: 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 redendency 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
CyclicRedundencyService - Interface in com.seventytwomiles.architecturerules.services: Interface for the CyclicRedundencyService to provide a contract for implementations to ahear to.
CyclicRedundencyServiceImpl - Class in com.seventytwomiles.architecturerules.services: Checks for cyclic redundency among app packages in the source folders.
CyclicRedundencyServiceImpl(Configuration) - Constructor for class com.seventytwomiles.architecturerules.services.CyclicRedundencyServiceImpl: Constructor instantiates a new CyclicRedundencyService






    D


    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.

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

    DigesterConfigurationFactory
    - Class in com.seventytwomiles.architecturerules.configuration.xml
Apache Commons Digester implementatino of the
    ConfigurationFactory

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

    DigesterConfigurationFactory(String)
    -
    Constructor for class
    com.seventytwomiles.architecturerules.configuration.xml.DigesterConfigurationFactory
Instanciates a new ConfigurationFactory and processes the
    configuration found in the File with the given
    configurationFileName.

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

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

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





    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.

    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.Configuration
Getter for property Configuration.rules.

    getRules()
    -
    Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration
Getter for property Configuration.rules.

    getRules()
    -
    Method in class com.seventytwomiles.architecturerules.configuration.xml.AbstractConfigurationFactory
Getter for property AbstractConfigurationFactory.rules.

    getRules()
    -
    Method in interface
    com.seventytwomiles.architecturerules.configuration.xml.ConfigurationFactory
Getter for property /rules.

    getSources()
    -
    Method in class com.seventytwomiles.architecturerules.configuration.Configuration
Getter for property Configuration.sources.

    getSources()
    -
    Method in class com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration
Getter for property Configuration.sources.

    getSources()
    -
    Method in class com.seventytwomiles.architecturerules.configuration.xml.AbstractConfigurationFactory
Getter for property AbstractConfigurationFactory.sources.

    getSources()
    -
    Method in interface
    com.seventytwomiles.architecturerules.configuration.xml.ConfigurationFactory
Getter for property //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
    
 
    

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

        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(String,
            Throwable) -
        Constructor for exception
        com.seventytwomiles.architecturerules.exceptions.InvalidConfigurationException
    
 
    

        InvalidConfigurationException(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,
            Throwable) -
        Constructor for exception
        com.seventytwomiles.architecturerules.exceptions.NoPackagesFoundException
    
 
    

        NoPackagesFoundException(String)
        -
        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

    
        performCyclicRedundencyCheck()
        -
        Method in interface com.seventytwomiles.architecturerules.services.CyclicRedundencyService
    
Check all the packages in all of the source directories and search for
        any cyclic redundenc/p>
    

        performCyclicRedundencyCheck()
        -
        Method in class com.seventytwomiles.architecturerules.services.CyclicRedundencyServiceImpl
    
Check all the packages in all of the source directories and search for
        any cyclic redundenc/p>
    

        performRulesTest()
        -
        Method in interface com.seventytwomiles.architecturerules.services.RulesService
    
Assert that no Rule in the given Configuraiton
        has been violated.
    

        performRulesTest()
        -
        Method in class com.seventytwomiles.architecturerules.services.RulesServiceImpl
    
Assert that no Rule in the given Configuraiton
        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.
    
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
    
Instanciates a new Rule with the given id.
    

        Rule(String,
            String) -
        Constructor for class com.seventytwomiles.architecturerules.domain.Rule
    
Instanciates a new Rule with the given id.
    

        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 configuraiton 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


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


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


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


    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(String,
        Throwable) -
    Constructor for exception
    com.seventytwomiles.architecturerules.exceptions.SourceNotFoundException
 

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

    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
 





    T

    
        testArchitecture()
        -
        Method in class com.seventytwomiles.architecturerules.AbstractArchitectureRulesConfigurationTest
    
Implement this method and call AbstractArchitectureRulesConfigurationTest.doTests()
    

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

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

        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 Configuraiton instance
        whos
        setters and collections are unavailable or unmodifiable.
    

        UnmodifiableConfiguration(Configuration)
        -
        Constructor for class
        com.seventytwomiles.architecturerules.configuration.UnmodifiableConfiguration
    
Instanciates a new unmodifiable configuration class.


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





    
        
            
            
                
                    Overview 
                    
                    Package 
                    Class 
                    Use 
                    Tree 
                    
                    Deprecated 
                    
                      Index 
                    
                    Help 
                    
                
            
        
        
        
        
    

    
        
             PREV 
             NEXT
        
            FRAMES  
             NO FRAMES
             
             
            
            


        
    





Copyright © 2007. All Rights Reserved.