Class ConfigDataResourceNotFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.boot.context.config.ConfigDataException

org.springframework.boot.context.config.ConfigDataNotFoundException

org.springframework.boot.context.config.ConfigDataResourceNotFoundException

All Implemented Interfaces:

Serializable, OriginProvider

public class ConfigDataResourceNotFoundException
extends ConfigDataNotFoundException

ConfigDataNotFoundException thrown when a ConfigDataResource cannot be found.

Since:

2.4.0

Author:

Phillip Webb

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConfigDataResourceNotFoundException(ConfigDataResource resource)	Create a new ConfigDataResourceNotFoundException instance.
ConfigDataResourceNotFoundException(ConfigDataResource resource, @Nullable Throwable cause)	Create a new ConfigDataResourceNotFoundException instance.

Method Summary

Modifier and Type	Method	Description
@Nullable ConfigDataLocation	getLocation()	Return the original location that was resolved to determine the resource.
@Nullable Origin	getOrigin()	Return the source origin or null if the origin is not known.
String	getReferenceDescription()	Return a description of actual referenced item that could not be found.
ConfigDataResource	getResource()	Return the resource that could not be found.
static void	throwIfDoesNotExist(ConfigDataResource resource, File fileToCheck)	Throw a ConfigDataNotFoundException if the specified File does not exist.
static void	throwIfDoesNotExist(ConfigDataResource resource, Path pathToCheck)	Throw a ConfigDataNotFoundException if the specified Path does not exist.
static void	throwIfDoesNotExist(ConfigDataResource resource, Resource resourceToCheck)	Throw a ConfigDataNotFoundException if the specified Resource does not exist.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Details

ConfigDataResourceNotFoundException

public ConfigDataResourceNotFoundException(ConfigDataResource resource)

Create a new ConfigDataResourceNotFoundException instance.

Parameters:

resource - the resource that could not be found

ConfigDataResourceNotFoundException

public ConfigDataResourceNotFoundException(ConfigDataResource resource,
 @Nullable Throwable cause)

Create a new ConfigDataResourceNotFoundException instance.

Parameters:

resource - the resource that could not be found

cause - the exception cause

Method Details

getResource

public ConfigDataResource getResource()

Return the resource that could not be found.

Returns:

the resource

getLocation

public @Nullable ConfigDataLocation getLocation()

Return the original location that was resolved to determine the resource.

Returns:

the location or null if no location is available

getOrigin

public @Nullable Origin getOrigin()

Description copied from interface: OriginProvider

Return the source origin or null if the origin is not known.

Returns:

the origin or null

getReferenceDescription

public String getReferenceDescription()

Description copied from class: ConfigDataNotFoundException

Return a description of actual referenced item that could not be found.

Specified by:

getReferenceDescription in class ConfigDataNotFoundException

Returns:

a description of the referenced items

throwIfDoesNotExist

public static void throwIfDoesNotExist(ConfigDataResource resource,
 Path pathToCheck)

Throw a ConfigDataNotFoundException if the specified Path does not exist.

Parameters:

resource - the config data resource

pathToCheck - the path to check

throwIfDoesNotExist

public static void throwIfDoesNotExist(ConfigDataResource resource,
 File fileToCheck)

Throw a ConfigDataNotFoundException if the specified File does not exist.

Parameters:

resource - the config data resource

fileToCheck - the file to check

throwIfDoesNotExist

public static void throwIfDoesNotExist(ConfigDataResource resource,
 Resource resourceToCheck)

Throw a ConfigDataNotFoundException if the specified Resource does not exist.

Parameters:

resource - the config data resource

resourceToCheck - the resource to check