net.sourceforge.javadpkg

Interface Context

All Known Implementing Classes:

ContextImpl

public interface Context

A context for various actions like parsing or building.

Version:

1.0, 23.04.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
void	addWarning(Warning warning) Adds a warning to the context.
List<Warning>	getWarnings() Returns a list of all warnings added to this context.

Method Detail

addWarning

void addWarning(Warning warning)

Adds a warning to the context.

Warnings can inform about unsupported parameters, unsupported values or combinations of these. The action will resume it's work (best-effort). If the problems prevents the rest of the action from working correctly an exception should be thrown.

Parameters:

warning - The warning.

Throws:

IllegalArgumentException - If the warning is null.

getWarnings

List<Warning> getWarnings()

Returns a list of all warnings added to this context.

The returned list will be a copy of the internal list. Modifications on the returned list don't have any effect on the internal list.

Returns:

The warnings.