Package ddf.catalog.security

Interface SourceWarningsFilter

public interface SourceWarningsFilter

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method	Description
boolean	canFilter(ProcessingDetails details)	This method determines whether this SourceWarningsFilter can correctly filter the ProcessingDetails passed to it
ProcessingDetails	filter(ProcessingDetails details)	If this SourceWarningsFilter can filter the ProcessingDetails passed to it, then this method applies a filter to the warnings of the ProcessingDetails

Method Details

canFilter

boolean canFilter(ProcessingDetails details)

This method determines whether this SourceWarningsFilter can correctly filter the ProcessingDetails passed to it

Parameters:

details - the ProcessingDetails which this method examines as part of its determination of whether this SourceWarningsFilter can correctly filter these details and not encounter an error or exception in the process

Returns:

true if this SourceWarningsFilter can correctly filter the details passed in; otherwise, false

filter

ProcessingDetails filter(ProcessingDetails details)

If this SourceWarningsFilter can filter the ProcessingDetails passed to it, then this method applies a filter to the warnings of the ProcessingDetails

Parameters:

details - the ProcessingDetails which contain the warnings which this method filters

Returns:

new ProcessingDetails which correspond to the details passed in except that the warnings of the new ProcessingDetails contain only the warnings of the original details which this method recognizes as useful to the user

Throws:

NullPointerException - if canFilter(details) determines that this SourceWarningsFilter cannot filter the details