org.apache.velocity.app.event
Interface NullSetEventHandler

All Superinterfaces:

EventHandler

public interface NullSetEventHandler
extends EventHandler

Event handler called when the RHS of #set is null. Lets an app approve / veto writing a log message based on the specific reference.

Version:

$Id: NullSetEventHandler.java 685685 2008-08-13 21:43:27Z nbubna $

Author:

Will Glass-Husain, Geir Magnusson Jr.

Nested Class Summary

static class

NullSetEventHandler.ShouldLogOnNullSetExecutor Defines the execution strategy for shouldLogOnNullSet

Method Summary

boolean

shouldLogOnNullSet(String lhs, String rhs) Called when the RHS of a #set() is null, which will result in a null LHS.

Method Detail

shouldLogOnNullSet

boolean shouldLogOnNullSet(String lhs,
                           String rhs)

Called when the RHS of a #set() is null, which will result in a null LHS. All NullSetEventHandlers are called in sequence until a false is returned. If no NullSetEventHandler is registered all nulls will be logged.

Parameters:

lhs - reference literal of left-hand-side of set statement

rhs - reference literal of right-hand-side of set statement

Returns:

true if log message should be written, false otherwise