Package com.tngtech.archunit.core.domain

Class ThrowsDeclaration<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>

java.lang.Object

com.tngtech.archunit.core.domain.ThrowsDeclaration<LOCATION>

Type Parameters:

LOCATION - Represents the 'location' where this ThrowsDeclaration is declared. This can be a JavaCodeUnit, i.e. a method or constructor. It can also be a CodeUnitCallTarget where the resolution process resolved this ThrowsDeclaration on all resolved targets.
To further elaborate, suppose we have three interfaces
interface A { void method() throws E1, E2{...} }
interface B { void method() throws E2, E3{...} }
interface C extends A, B {}
Since C can be assigned to either A or B, it follows that the inherited method C.method() only declares E2 as its only checked Exception.
Thus the ThrowsClause for the call target C.method() would only contain a ThrowsDeclaration with type E2.
For further information about the resolution process of AccessTargets to JavaMembers consult the documentation at AccessTarget.

All Implemented Interfaces:

HasOwner<ThrowsClause<LOCATION>>, HasType

@PublicAPI(usage=ACCESS)
public final class ThrowsDeclaration<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>
extends Object
implements HasType, HasOwner<ThrowsClause<LOCATION>>

Represents one declared exception of a ThrowsClause. I.e. for

void someMethod() throws FirstException, SecondException {...}

there would be one ThrowsDeclaration representing FirstException and one representing SecondException

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ThrowsDeclaration.Functions	Predefined functions to transform ThrowsDeclaration.

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasOwner

HasOwner.Predicates

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.HasType

HasType.Predicates

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
JavaClass	getDeclaringClass()
LOCATION	getLocation()
ThrowsClause<LOCATION>	getOwner()
JavaClass	getRawType()
ThrowsClause<LOCATION>	getThrowsClause()
JavaType	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getOwner

@PublicAPI(usage=ACCESS)
public ThrowsClause<LOCATION> getOwner()

Specified by:

getOwner in interface HasOwner<LOCATION extends HasParameterTypes & HasReturnType & HasName.AndFullName & CanBeAnnotated & HasOwner<JavaClass>>

Returns:

The ThrowsClause containing this declaration

getThrowsClause

@PublicAPI(usage=ACCESS)
public ThrowsClause<LOCATION> getThrowsClause()

getLocation

@PublicAPI(usage=ACCESS)
public LOCATION getLocation()

Returns:

The 'location' where this ThrowsDeclaration is declared. Can be either JavaCodeUnit or AccessTarget.CodeUnitCallTarget. Compare docs at ThrowsDeclaration.

getDeclaringClass

@PublicAPI(usage=ACCESS)
public JavaClass getDeclaringClass()

Returns:

The class that declares the ThrowsDeclaration (i.e. method, constructor, method call target, constructor call target) containing this ThrowsDeclaration

getType

@PublicAPI(usage=ACCESS)
public JavaType getType()

Specified by:

getType in interface HasType

getRawType

@PublicAPI(usage=ACCESS)
public JavaClass getRawType()

Specified by:

getRawType in interface HasType

Returns:

The type of this ThrowsDeclaration, e.g. for a method

void method() throws SomeException {...}

the JavaClass representing SomeException will be returned

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object