bboss.org.apache.velocity.app.event.implement

类 ReportInvalidReferences

java.lang.Object

bboss.org.apache.velocity.app.event.implement.ReportInvalidReferences

所有已实现的接口:

EventHandler, InvalidReferenceEventHandler, RuntimeServicesAware

public class ReportInvalidReferences
extends java.lang.Object
implements InvalidReferenceEventHandler, RuntimeServicesAware

Use this event handler to flag invalid references. Since this is intended to be used for a specific request, this should be used as a local event handler attached to a specific context instead of being globally defined in the Velocity properties file.

Note that InvalidReferenceHandler can be used in two modes. If the Velocity properties file contains the following:

 eventhandler.invalidreference.exception = true
 

then the event handler will throw a ParseErrorRuntimeException upon hitting the first invalid reference. This stops processing and is passed through to the application code. The ParseErrorRuntimeException contain information about the template name, line number, column number, and invalid reference.

If this configuration setting is false or omitted then the page will be processed as normal, but all invalid references will be collected in a List of InvalidReferenceInfo objects.

This feature should be regarded as experimental.

从以下版本开始:

1.5

嵌套类概要

从接口继承的嵌套类/接口 bboss.org.apache.velocity.app.event.InvalidReferenceEventHandler

InvalidReferenceEventHandler.InvalidGetMethodExecutor, InvalidReferenceEventHandler.InvalidMethodExecutor, InvalidReferenceEventHandler.InvalidSetMethodExecutor

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	EVENTHANDLER_INVALIDREFERENCE_EXCEPTION

构造器概要

构造器

构造器和说明
ReportInvalidReferences()

方法概要

限定符和类型	方法和说明
java.util.List	getInvalidReferences() All invalid references during the processing of this page.
java.lang.Object	invalidGetMethod(Context context, java.lang.String reference, java.lang.Object object, java.lang.String property, Info info) Collect the error and/or throw an exception, depending on configuration.
java.lang.Object	invalidMethod(Context context, java.lang.String reference, java.lang.Object object, java.lang.String method, Info info) Collect the error and/or throw an exception, depending on configuration.
boolean	invalidSetMethod(Context context, java.lang.String leftreference, java.lang.String rightreference, Info info) Collect the error and/or throw an exception, depending on configuration.
void	setRuntimeServices(RuntimeServices rs) Called automatically when event cartridge is initialized.

从类继承的方法 java.lang.Object

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

字段详细资料

EVENTHANDLER_INVALIDREFERENCE_EXCEPTION

public static final java.lang.String EVENTHANDLER_INVALIDREFERENCE_EXCEPTION

另请参阅:

常量字段值

构造器详细资料

ReportInvalidReferences

public ReportInvalidReferences()

方法详细资料

invalidGetMethod

public java.lang.Object invalidGetMethod(Context context,
                                         java.lang.String reference,
                                         java.lang.Object object,
                                         java.lang.String property,
                                         Info info)

Collect the error and/or throw an exception, depending on configuration.

指定者:

invalidGetMethod 在接口中 InvalidReferenceEventHandler

参数:

context - the context when the reference was found invalid

reference - string with complete invalid reference

object - the object referred to, or null if not found

property - the property name from the reference

info - contains template, line, column details

返回:

always returns null

抛出:

ParseErrorException

invalidMethod

public java.lang.Object invalidMethod(Context context,
                                      java.lang.String reference,
                                      java.lang.Object object,
                                      java.lang.String method,
                                      Info info)

Collect the error and/or throw an exception, depending on configuration.

指定者:

invalidMethod 在接口中 InvalidReferenceEventHandler

参数:

context - the context when the reference was found invalid

reference - complete invalid reference

object - the object referred to, or null if not found

method - the property name from the reference

info - contains template, line, column details

返回:

always returns null

抛出:

ParseErrorException

invalidSetMethod

public boolean invalidSetMethod(Context context,
                                java.lang.String leftreference,
                                java.lang.String rightreference,
                                Info info)

Collect the error and/or throw an exception, depending on configuration.

指定者:

invalidSetMethod 在接口中 InvalidReferenceEventHandler

参数:

context - the context when the reference was found invalid

leftreference - left reference being assigned to

rightreference - invalid reference on the right

info - contains info on template, line, col

返回:

loop to end -- always returns false

getInvalidReferences

public java.util.List getInvalidReferences()

All invalid references during the processing of this page.

返回:

a List of InvalidReferenceInfo objects

setRuntimeServices

public void setRuntimeServices(RuntimeServices rs)

Called automatically when event cartridge is initialized.

指定者:

setRuntimeServices 在接口中 RuntimeServicesAware

参数:

rs - RuntimeServices object assigned during initialization