Package org.springframework.modulith.core

Class Violations

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.modulith.core.Violations

All Implemented Interfaces:

Serializable

public class Violations
extends RuntimeException

Value type to gather and report architectural violations.

Author:

Oliver Drotbohm

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	Violations.Violation

Field Summary

Fields

Modifier and Type	Field	Description
static Violations	NONE

Method Summary

Modifier and Type	Method	Description
(package private) Violations	and(String violation)
(package private) Violations	and(Violations other)
(package private) Violations	and(Violations.Violation violation)	Creates a new Violations with the given RuntimeException added to the current ones?
String	getMessage()
List<String>	getMessages()	Returns all violations' messages.
boolean	hasViolations()	Returns whether there are violations available.
void	throwIfPresent()	Throws itself in case it's not an empty instance.
(package private) static Collector<Violations.Violation,?,Violations>	toViolations()	A Collector to turn a Stream of RuntimeExceptions into a Violations instance.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static Violations NONE

Method Details

toViolations

static Collector<Violations.Violation,?,Violations> toViolations()

A Collector to turn a Stream of RuntimeExceptions into a Violations instance.

Returns:

will never be null.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getMessages

public List<String> getMessages()

Returns all violations' messages.

Returns:

will never be null.

Since:

1.1

hasViolations

public boolean hasViolations()

Returns whether there are violations available.

Returns:

throwIfPresent

public void throwIfPresent()

Throws itself in case it's not an empty instance.

and

Violations and(Violations.Violation violation)

Creates a new Violations with the given RuntimeException added to the current ones?

Parameters:

violation - must not be null.

Returns:

and

Violations and(Violations other)

and

Violations and(String violation)