Package com.tngtech.archunit.library.freeze

Class ViolationStore.Delegate

java.lang.Object

com.tngtech.archunit.library.freeze.ViolationStore.Delegate

All Implemented Interfaces:

ViolationStore

Enclosing interface:

ViolationStore

@PublicAPI(usage=INHERITANCE)
public static class ViolationStore.Delegate
extends Object
implements ViolationStore

A simple delegate for a ViolationStore to allow adjusting the behavior of another ViolationStore by delegation (e.g. TextFileBasedViolationStore)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tngtech.archunit.library.freeze.ViolationStore

ViolationStore.Delegate

Constructor Summary

Constructors

Constructor	Description
Delegate(ViolationStore delegate)

Method Summary

Modifier and Type	Method	Description
boolean	contains(ArchRule rule)
List<String>	getViolations(ArchRule rule)
void	initialize(Properties properties)	Provides custom initialization with properties derived from "archunit.properties" by considering the sub properties of freeze.store.
void	save(ArchRule rule, List<String> violations)	Provides a way to initially store or later update violations of an ArchRule.

Methods inherited from class java.lang.Object

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

Constructor Details

Delegate

public Delegate(ViolationStore delegate)

Method Details

initialize

public void initialize(Properties properties)

Description copied from interface: ViolationStore

Provides custom initialization with properties derived from "archunit.properties" by considering the sub properties of freeze.store.

If "archunit.properties" contains, e.g.,

 freeze.store.propOne=valueOne
 freeze.store.propTwo=valueTwo
 

then this method will be called with properties containing

 propOne=valueOne
 propTwo=valueTwo

Specified by:

initialize in interface ViolationStore

Parameters:

properties - The properties derived from the "archunit.properties" prefix freeze.store.

contains

public boolean contains(ArchRule rule)

Specified by:

contains in interface ViolationStore

Parameters:

rule - An ArchRule

Returns:

true, if and only if this ViolationStore contains stored violations for the passed ArchRule

save

public void save(ArchRule rule,
 List<String> violations)

Description copied from interface: ViolationStore

Provides a way to initially store or later update violations of an ArchRule. If there are violations currently stored for the passed rule, those violations will be completely overwritten.

Specified by:

save in interface ViolationStore

Parameters:

rule - An ArchRule to store violations for

violations - A list of lines of violations of an ArchRule

getViolations

public List<String> getViolations(ArchRule rule)

Specified by:

getViolations in interface ViolationStore

Parameters:

rule - An ArchRule

Returns:

The lines of violations currently stored for the passed ArchRule