Package org.apache.velocity.example

Class EventExample

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.velocity.app.event.EventHandler, org.apache.velocity.app.event.InvalidReferenceEventHandler, org.apache.velocity.app.event.MethodExceptionEventHandler, org.apache.velocity.app.event.ReferenceInsertionEventHandler, org.slf4j.Logger
    public class EventExample
extends org.slf4j.helpers.MarkerIgnoringBase
implements org.apache.velocity.app.event.ReferenceInsertionEventHandler, org.apache.velocity.app.event.MethodExceptionEventHandler, org.apache.velocity.app.event.InvalidReferenceEventHandler
    This class is a simple demonstration of how the event handling features of the Velocity Servlet Engine are used. It uses a custom logger as well to check the log message stream when testing the InvalidReferenceEventHandler.
    Version:
    $Id$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      EventExample()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void debug​(java.lang.String msg)  
      void debug​(java.lang.String format, java.lang.Object param1)  
      void debug​(java.lang.String format, java.lang.Object... argArray)  
      void debug​(java.lang.String format, java.lang.Object param1, java.lang.Object param2)  
      void debug​(java.lang.String msg, java.lang.Throwable t)  
      void error​(java.lang.String msg)  
      void error​(java.lang.String format, java.lang.Object arg)  
      void error​(java.lang.String format, java.lang.Object... argArray)  
      void error​(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)  
      void error​(java.lang.String msg, java.lang.Throwable t)  
      void formatAndLog​(int level, java.lang.String format, java.lang.Object... arguments)
      This prints the level and formatted message to System.out.
      java.lang.String getName()
      Required init methods for Logger interface
      void info​(java.lang.String msg)  
      void info​(java.lang.String format, java.lang.Object arg)  
      void info​(java.lang.String format, java.lang.Object... argArray)  
      void info​(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)  
      void info​(java.lang.String msg, java.lang.Throwable t)  
      java.lang.Object invalidGetMethod​(org.apache.velocity.context.Context context, java.lang.String reference, java.lang.Object object, java.lang.String property, org.apache.velocity.util.introspection.Info info)  
      java.lang.Object invalidMethod​(org.apache.velocity.context.Context context, java.lang.String reference, java.lang.Object object, java.lang.String method, org.apache.velocity.util.introspection.Info info)  
      boolean invalidSetMethod​(org.apache.velocity.context.Context context, java.lang.String leftreference, java.lang.String rightreference, org.apache.velocity.util.introspection.Info info)
      Event handler for when the right hand side of a #set() directive is null, which results in a log message.
      boolean isDebugEnabled()  
      boolean isErrorEnabled()  
      boolean isInfoEnabled()  
      boolean isLevelEnabled​(int level)
      This always returns true because logging levels can't be disabled in this impl.
      boolean isTraceEnabled()  
      boolean isWarnEnabled()  
      void log​(int level, java.lang.String message)
      This just prints the message and level to System.out.
      void log​(int level, java.lang.String message, java.lang.Throwable t)
      This prints the level, message, and the Throwable's message to System.out.
      static void main​(java.lang.String[] args)  
      java.lang.Object methodException​(org.apache.velocity.context.Context context, java.lang.Class claz, java.lang.String method, java.lang.Exception e, org.apache.velocity.util.introspection.Info info)  
      protected java.lang.Object readResolve()  
      java.lang.Object referenceInsert​(org.apache.velocity.context.Context context, java.lang.String reference, java.lang.Object value)
      Event handler for when a reference is inserted into the output stream.
      void throwException()
      silly method to throw an exception to demonstrate the method invocation exception event handling
      void trace​(java.lang.String msg)  
      void trace​(java.lang.String format, java.lang.Object param1)  
      void trace​(java.lang.String format, java.lang.Object... argArray)  
      void trace​(java.lang.String format, java.lang.Object param1, java.lang.Object param2)  
      void trace​(java.lang.String msg, java.lang.Throwable t)  
      void warn​(java.lang.String msg)  
      void warn​(java.lang.String format, java.lang.Object arg)  
      void warn​(java.lang.String format, java.lang.Object... argArray)  
      void warn​(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)  
      void warn​(java.lang.String msg, java.lang.Throwable t)  

      • Methods inherited from class org.slf4j.helpers.MarkerIgnoringBase

        debug, debug, debug, debug, debug, error, error, error, error, error, info, info, info, info, info, isDebugEnabled, isErrorEnabled, isInfoEnabled, isTraceEnabled, isWarnEnabled, toString, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • logOutput

        private boolean logOutput

      • exceptionSwitch

        private boolean exceptionSwitch

      • name

        protected java.lang.String name

    • Constructor Detail

      • EventExample

        public EventExample()

    • Method Detail

      • main

        public static void main​(java.lang.String[] args)

      • throwException

        public void throwException()
                    throws java.lang.Exception
        silly method to throw an exception to demonstrate the method invocation exception event handling
        Throws:
        java.lang.Exception

      • referenceInsert

        public java.lang.Object referenceInsert​(org.apache.velocity.context.Context context,
                                        java.lang.String reference,
                                        java.lang.Object value)
        Event handler for when a reference is inserted into the output stream.
        Specified by:
        referenceInsert in interface org.apache.velocity.app.event.ReferenceInsertionEventHandler

      • invalidGetMethod

        public java.lang.Object invalidGetMethod​(org.apache.velocity.context.Context context,
                                         java.lang.String reference,
                                         java.lang.Object object,
                                         java.lang.String property,
                                         org.apache.velocity.util.introspection.Info info)
        Specified by:
        invalidGetMethod in interface org.apache.velocity.app.event.InvalidReferenceEventHandler

      • invalidMethod

        public java.lang.Object invalidMethod​(org.apache.velocity.context.Context context,
                                      java.lang.String reference,
                                      java.lang.Object object,
                                      java.lang.String method,
                                      org.apache.velocity.util.introspection.Info info)
        Specified by:
        invalidMethod in interface org.apache.velocity.app.event.InvalidReferenceEventHandler

      • invalidSetMethod

        public boolean invalidSetMethod​(org.apache.velocity.context.Context context,
                                java.lang.String leftreference,
                                java.lang.String rightreference,
                                org.apache.velocity.util.introspection.Info info)
        Event handler for when the right hand side of a #set() directive is null, which results in a log message. This method gives the application a chance to 'vote' on msg generation
        Specified by:
        invalidSetMethod in interface org.apache.velocity.app.event.InvalidReferenceEventHandler

      • methodException

        public java.lang.Object methodException​(org.apache.velocity.context.Context context,
                                        java.lang.Class claz,
                                        java.lang.String method,
                                        java.lang.Exception e,
                                        org.apache.velocity.util.introspection.Info info)
        Specified by:
        methodException in interface org.apache.velocity.app.event.MethodExceptionEventHandler

      • log

        public void log​(int level,
                java.lang.String message)
        This just prints the message and level to System.out.

      • log

        public void log​(int level,
                java.lang.String message,
                java.lang.Throwable t)
        This prints the level, message, and the Throwable's message to System.out.

      • formatAndLog

        public void formatAndLog​(int level,
                         java.lang.String format,
                         java.lang.Object... arguments)
        This prints the level and formatted message to System.out.

      • isLevelEnabled

        public boolean isLevelEnabled​(int level)
        This always returns true because logging levels can't be disabled in this impl.

      • getName

        public java.lang.String getName()
        Required init methods for Logger interface
        Specified by:
        getName in interface org.slf4j.Logger

      • isTraceEnabled

        public boolean isTraceEnabled()
        Specified by:
        isTraceEnabled in interface org.slf4j.Logger

      • trace

        public void trace​(java.lang.String msg)
        Specified by:
        trace in interface org.slf4j.Logger

      • trace

        public void trace​(java.lang.String format,
                  java.lang.Object param1)
        Specified by:
        trace in interface org.slf4j.Logger

      • trace

        public void trace​(java.lang.String format,
                  java.lang.Object param1,
                  java.lang.Object param2)
        Specified by:
        trace in interface org.slf4j.Logger

      • trace

        public void trace​(java.lang.String format,
                  java.lang.Object... argArray)
        Specified by:
        trace in interface org.slf4j.Logger

      • trace

        public void trace​(java.lang.String msg,
                  java.lang.Throwable t)
        Specified by:
        trace in interface org.slf4j.Logger

      • isDebugEnabled

        public boolean isDebugEnabled()
        Specified by:
        isDebugEnabled in interface org.slf4j.Logger

      • debug

        public void debug​(java.lang.String msg)
        Specified by:
        debug in interface org.slf4j.Logger

      • debug

        public void debug​(java.lang.String format,
                  java.lang.Object param1)
        Specified by:
        debug in interface org.slf4j.Logger

      • debug

        public void debug​(java.lang.String format,
                  java.lang.Object param1,
                  java.lang.Object param2)
        Specified by:
        debug in interface org.slf4j.Logger

      • debug

        public void debug​(java.lang.String format,
                  java.lang.Object... argArray)
        Specified by:
        debug in interface org.slf4j.Logger

      • debug

        public void debug​(java.lang.String msg,
                  java.lang.Throwable t)
        Specified by:
        debug in interface org.slf4j.Logger

      • isInfoEnabled

        public boolean isInfoEnabled()
        Specified by:
        isInfoEnabled in interface org.slf4j.Logger

      • info

        public void info​(java.lang.String msg)
        Specified by:
        info in interface org.slf4j.Logger

      • info

        public void info​(java.lang.String format,
                 java.lang.Object arg)
        Specified by:
        info in interface org.slf4j.Logger

      • info

        public void info​(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)
        Specified by:
        info in interface org.slf4j.Logger

      • info

        public void info​(java.lang.String format,
                 java.lang.Object... argArray)
        Specified by:
        info in interface org.slf4j.Logger

      • info

        public void info​(java.lang.String msg,
                 java.lang.Throwable t)
        Specified by:
        info in interface org.slf4j.Logger

      • isWarnEnabled

        public boolean isWarnEnabled()
        Specified by:
        isWarnEnabled in interface org.slf4j.Logger

      • warn

        public void warn​(java.lang.String msg)
        Specified by:
        warn in interface org.slf4j.Logger

      • warn

        public void warn​(java.lang.String format,
                 java.lang.Object arg)
        Specified by:
        warn in interface org.slf4j.Logger

      • warn

        public void warn​(java.lang.String format,
                 java.lang.Object arg1,
                 java.lang.Object arg2)
        Specified by:
        warn in interface org.slf4j.Logger

      • warn

        public void warn​(java.lang.String format,
                 java.lang.Object... argArray)
        Specified by:
        warn in interface org.slf4j.Logger

      • warn

        public void warn​(java.lang.String msg,
                 java.lang.Throwable t)
        Specified by:
        warn in interface org.slf4j.Logger

      • isErrorEnabled

        public boolean isErrorEnabled()
        Specified by:
        isErrorEnabled in interface org.slf4j.Logger

      • error

        public void error​(java.lang.String msg)
        Specified by:
        error in interface org.slf4j.Logger

      • error

        public void error​(java.lang.String format,
                  java.lang.Object arg)
        Specified by:
        error in interface org.slf4j.Logger

      • error

        public void error​(java.lang.String format,
                  java.lang.Object arg1,
                  java.lang.Object arg2)
        Specified by:
        error in interface org.slf4j.Logger

      • error

        public void error​(java.lang.String format,
                  java.lang.Object... argArray)
        Specified by:
        error in interface org.slf4j.Logger

      • error

        public void error​(java.lang.String msg,
                  java.lang.Throwable t)
        Specified by:
        error in interface org.slf4j.Logger

      • readResolve

        protected java.lang.Object readResolve()
                                throws java.io.ObjectStreamException
        Throws:
        java.io.ObjectStreamException