vona.rmi.rmiwrap

Class RMIWrap.WrapperBodyWriter

java.lang.Object

vona.rmi.rmiwrap.RMIWrap.WrapperBodyWriter

Direct Known Subclasses:

RMIWrap.ImplementationWriter, RMIWrap.InterfaceWriter

Enclosing class:

RMIWrap

protected abstract static class RMIWrap.WrapperBodyWriter
extends java.lang.Object

Encapsulates the ability to write the body of a wrapper class.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class	interfaceClass The interface class (i.e.
protected java.lang.String	interfaceName The type name of interfaceClass.

Constructor Summary

Constructors

Constructor and Description
RMIWrap.WrapperBodyWriter(java.lang.Class interfaceClass) Create a new WrapperBodyWriter with the given interface class.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) java.lang.String	classDeclExtra() Extra stuff (e.g.
(package private) abstract void	processMethod(java.io.PrintWriter out, java.lang.reflect.Method method) Called by the default impl of writeWrapperBody(java.io.PrintWriter) to process a method of interfaceClass.
(package private) void	writeDropoutHook(java.io.PrintWriter out, java.lang.String hookName, java.lang.reflect.Method method, java.lang.String paramsExtra) Write a dropout hook.
(package private) void	writeSignature(java.io.PrintWriter out, java.lang.reflect.Method method, boolean remote, boolean handler) Write a method signature.
(package private) void	writeTypeUnwrap(java.io.PrintWriter out, java.lang.Class type, java.lang.String name, java.lang.String prefix, java.lang.String suffix) Write a type unwrap block.
(package private) void	writeTypeWrap(java.io.PrintWriter out, java.lang.Class type, java.lang.String name, java.lang.String prefix, java.lang.String suffix) Write a type wrap block.
(package private) void	writeWrapperBody(java.io.PrintWriter out) Write the body of the wrapper class.

Methods inherited from class java.lang.Object

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

Field Detail

interfaceClass

protected java.lang.Class interfaceClass

The interface class (i.e. foo.API) for which a wrapper is being written.

interfaceName

protected java.lang.String interfaceName

The type name of interfaceClass.

Constructor Detail

RMIWrap.WrapperBodyWriter

RMIWrap.WrapperBodyWriter(java.lang.Class interfaceClass)

Create a new WrapperBodyWriter with the given interface class.

Parameters:

interfaceClass - the interface class (i.e. foo.API)

Method Detail

writeWrapperBody

void writeWrapperBody(java.io.PrintWriter out)

Write the body of the wrapper class.

Default impl calls processMethod(java.io.PrintWriter, java.lang.reflect.Method) for all methods of interfaceClass.

Parameters:

out - where to write

processMethod

abstract void processMethod(java.io.PrintWriter out,
                 java.lang.reflect.Method method)

Called by the default impl of writeWrapperBody(java.io.PrintWriter) to process a method of interfaceClass.

Parameters:

out - where to write

method - the Method to process

classDeclExtra

java.lang.String classDeclExtra()

Extra stuff (e.g. extends and implements specs) that should be added at the end of the class declaration.

Default impl returns the empty string.

Returns:

Extra stuff (e.g. extends and implements specs) that should be added at the end of the class declaration

writeSignature

void writeSignature(java.io.PrintWriter out,
                  java.lang.reflect.Method method,
                  boolean remote,
                  boolean handler)

Write a method signature.

Parameters:

out - where to write

method - the Method for which to write a signature

remote - whether to write a remote sig (adding "Remote" to the method name and throwing RemoteException)

handler - whether to write a RemoteException handler sig (adding "RemoteException" to the method name and taking an additional RemoteException parameter e)

writeTypeUnwrap

void writeTypeUnwrap(java.io.PrintWriter out,
                   java.lang.Class type,
                   java.lang.String name,
                   java.lang.String prefix,
                   java.lang.String suffix)

Write a type unwrap block.

Parameters:

out - where to write

type - the type to unwrap

name - the symbol name to unwrap

prefix - optional prefix to write before the unwrap, null for none

suffix - optional suffix to write after the unwrap, null for none

writeTypeWrap

void writeTypeWrap(java.io.PrintWriter out,
                 java.lang.Class type,
                 java.lang.String name,
                 java.lang.String prefix,
                 java.lang.String suffix)

Write a type wrap block.

Parameters:

out - where to write

type - the type to wrap

name - the symbol name to wrap

prefix - optional prefix to write before the wrap, null for none

suffix - optional suffix to write after the wrap, null for none

writeDropoutHook

void writeDropoutHook(java.io.PrintWriter out,
                    java.lang.String hookName,
                    java.lang.reflect.Method method,
                    java.lang.String paramsExtra)

Write a dropout hook.

A dropout hook is a call to hookName and a check of the return value. If the return is not null, then it is returned immediately.

Parameters:

out - where to write

hookName - the name of the hook to call

method - the method from which the hook is being called

paramsExtra - extra parameters to add to the hook call (all params of method will be added first)