oracle.ifs.beans.parsers

Interface ParserCallback

public interface ParserCallback

A ParserCallback allows an application to interact with a Parser.

If a ParserCallback is specified in calling Parser.parse, the Parser will invoke ParserCallback methods as parsing is performed, allowing limited well-defined interaction between the application and the Parser.

Version:

1.0

Author:

David Pitfield

(Unpublished)

Method Summary

Modifier and Type	Method and Description
void	postOperation(LibraryObject libobj) Invoked immediately after performing an operation on a LibraryObject.
LibraryObjectDefinition	preOperation(LibraryObject libobj, LibraryObjectDefinition lodef) Invoked immediately prior to performing an operation on a LibraryObject.
void	signalException(IfsException exception) Signals a parsing-related exception.

Method Detail

preOperation

LibraryObjectDefinition preOperation(LibraryObject libobj,
                                     LibraryObjectDefinition lodef)
                              throws IfsException

Invoked immediately prior to performing an operation on a LibraryObject.

Parameters:

libobj - the LibraryObject on which the operation will be performed; null if the operation will create a new LibraryObject

lodef - the operation proposed by the Parser

Returns:

the operation mandated by the application. To accept the operation proposed by the Parser, simply return def. To specify a different operation, either return an altered def or construct and return a different definition. Return null to cancel the operation altogether.

Throws:

IfsException - if the operation fails; this will abort parsing

(Unpublished)

postOperation

void postOperation(LibraryObject libobj)
            throws IfsException

Invoked immediately after performing an operation on a LibraryObject.

Parameters:

libobj - the LibraryObject

Throws:

IfsException - if the operation fails; this will abort parsing

(Unpublished)

signalException

void signalException(IfsException exception)
              throws IfsException

Signals a parsing-related exception.

The ParserCallback implementation can either throw the exception, or simply return, in which case parsing continues.

Parameters:

exception - the potential exception

Throws:

IfsException - this will abort parsing

(Unpublished)