Package com.polarion.platform.repository.config

Interface IConfigProblemCatcher

public interface IConfigProblemCatcher

Catches problems which occur during processing of configuration files stored in repository.

Since:

3.1.2

Version:

$Revision$ $Date$

Author:

Stepan Roh

See Also:

• IRepositoryConfigService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IConfigProblemCatcher.IProblem	Problem.
static enum	IConfigProblemCatcher.Severity	Problem severity.

Method Summary

Modifier and Type	Method	Description
void	clearProblems()	Forgets all problems.
void	clearProblems(ILocation location)	Forgets all problems for given location.
void	finishCatching(ILocation location)	Ends catching sequence.
Collection<ILocation>	getProblematicLocations()	Returns list of problematic locations.
Collection<IConfigProblemCatcher.IProblem>	getProblems(ILocation location)	Returns problems for given location.
void	reportProblem(ILocation location, IConfigProblemCatcher.Severity severity, String message, Throwable throwable)	Report problem in configuration file.
void	startCatching(ILocation location)	Begins catching sequence.

Method Details

startCatching

void startCatching(ILocation location)

Begins catching sequence.

Catching sequence MUST end with finishCatching(ILocation).

Allowed to be called only by IDataHandlers.

Parameters:

location - location (can be null)

See Also:

• finishCatching(ILocation)

reportProblem

void reportProblem(ILocation location,
 IConfigProblemCatcher.Severity severity,
 String message,
 Throwable throwable)

Report problem in configuration file.

startCatching(ILocation) with the same location *MUST* be called first.

Allowed to be called only by IDataHandlers.

Parameters:

location - location or null for problem for which the exact origin is unknown

severity - severity (not null)

message - problem description or null

throwable - exception or null

See Also:

• startCatching(ILocation)

finishCatching

void finishCatching(ILocation location)

Ends catching sequence.

Catching sequence MUST start with startCatching(ILocation).

Replaces all previous problems for given location with new problems (if any) gathered during the catching sequence.

Allowed to be called only by IDataHandlers.

Parameters:

location - location (can be null)

See Also:

• startCatching(ILocation)
• getProblematicLocations()
• getProblems(ILocation)

clearProblems

void clearProblems()

Forgets all problems.

Does not influence any running catching sequences.

clearProblems

void clearProblems(ILocation location)

Forgets all problems for given location.

Does not influence any running catching sequences.

Parameters:

location - location (can be null)

getProblematicLocations

Collection<ILocation> getProblematicLocations()

Returns list of problematic locations.

Does not return problems reported during not-yet-finished catching sequences.

Returns:

locations with problems (not null)

getProblems

Collection<IConfigProblemCatcher.IProblem> getProblems(ILocation location)

Returns problems for given location.

Does not return problems reported during not-yet-finished catching sequences.

Parameters:

location - location (can be null)

Returns:

problems (not null)