2006-04-10, rgf

org.apache.bsf.util
Class BSFEventProcessorReturningEventInfos

java.lang.Object
  extended byorg.apache.bsf.util.BSFEventProcessorReturningEventInfos
All Implemented Interfaces:
EventProcessor

public class BSFEventProcessorReturningEventInfos
extends java.lang.Object
implements EventProcessor

This is used to support binding scripts to be run when an event occurs, forwarding the arguments supplied to the event listener. It is an adapted version of BSFEventProcessor.

------------------------ Apache Version 2.0 license -------------------------
    Copyright (C) 2001-2006 Rony G. Flatscher

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
 ----------------------------------------------------------------------------- 

Author:
Rony G. Flatscher, but most of the code copied from org.apache.bsf.util.BSFEventProcessor by Sanjiva Weerawarana
See Also:
{@link org.apache.bsf.util.BSFEventProcessor}

Field Summary
(package private)  int columnNo
           
(package private)  java.lang.Object dataFromScriptingEngine
           
(package private)  BSFEngine engine
           
(package private)  java.lang.String filter
           
(package private)  int lineNo
           
(package private)  BSFManager manager
           
(package private)  java.lang.Object script
           
(package private)  java.lang.String source
           
 
Constructor Summary
(package private) BSFEventProcessorReturningEventInfos(BSFEngine engine, BSFManager manager, java.lang.String filter, java.lang.String source, int lineNo, int columnNo, java.lang.Object script, java.lang.Object dataFromScriptingEngine)
          Package-protected constructor makes this class unavailable for public use.
 
Method Summary
 void processEvent(java.lang.String inFilter, java.lang.Object[] evtInfo)
           
 void processExceptionableEvent(java.lang.String inFilter, java.lang.Object[] evtInfo)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

engine

BSFEngine engine

manager

BSFManager manager

filter

java.lang.String filter

source

java.lang.String source

lineNo

int lineNo

columnNo

int columnNo

script

java.lang.Object script

dataFromScriptingEngine

java.lang.Object dataFromScriptingEngine
Constructor Detail

BSFEventProcessorReturningEventInfos

BSFEventProcessorReturningEventInfos(BSFEngine engine,
                                     BSFManager manager,
                                     java.lang.String filter,
                                     java.lang.String source,
                                     int lineNo,
                                     int columnNo,
                                     java.lang.Object script,
                                     java.lang.Object dataFromScriptingEngine)
                               throws BSFException
Package-protected constructor makes this class unavailable for public use.

Parameters:
dataFromScriptingEngine - this contains any object supplied by the scripting engine and gets sent back with the supplied script. This could be used e.g. for indicating which scripting engine object should be ultimately informed of the event occurrence.
Method Detail

processEvent

public void processEvent(java.lang.String inFilter,
                         java.lang.Object[] evtInfo)
Specified by:
processEvent in interface EventProcessor

processExceptionableEvent

public void processExceptionableEvent(java.lang.String inFilter,
                                      java.lang.Object[] evtInfo)
                               throws java.lang.Exception
Specified by:
processExceptionableEvent in interface EventProcessor
Throws:
java.lang.Exception

2006-04-10, rgf