csbase.tools

Class Generator

java.lang.Object

csbase.tools.Generator

Direct Known Subclasses:

UnavailableServiceGenerator

public abstract class Generator
extends Object

Funcionalidade comum aos geradores de classes auxiliares para serviço do csbase

Author:

Jorge Alexandre e Ana Moura

Field Summary

Fields

Modifier and Type	Field and Description
protected String	genClassName
protected String	interfaceName
protected String	serviceClassName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Generator(String interfaceName, String serviceClassName, String suffix) Contrói uma instância do gerador.

Method Summary

Modifier and Type	Method and Description
protected void	flushToFile(StringBuffer code) Descarrega o buffer para um arquivo.
protected void	generate() Gera o código fonte em um StringBuffer
protected StringBuffer	getBuffer() Obtém o buffer que armazena o código.
protected String[]	getConstructorExceptions() Acrescenta exceções específicas a um construtor.
protected abstract void	getConstructorLines(StringBuffer code, String[] paremeterNames) Acrescenta as linhas de código a um construtor.
protected abstract String[]	getImports() Obtém os pacotes a serem importados pela classe gerada.
protected abstract void	getMethodLines(StringBuffer code, Method method, String[] parameterNames) Acrescenta ao código a implementação de um método.
protected static String	getNoPackagesClassName(String className) Obtém o nome de uma classe, sem o pacote.
protected static String	getPackageName(String className) Obtém o nome do pacote de uma classe.
protected abstract Class	getSuperClass() Obtém a super classe da classe gerada.
protected abstract String	getSuperClassName() Obtém o nome da super classe da classe gerada.
protected abstract boolean	invokesSuperClassConstructor() Indica se o construtor da classe gerada invoca o construtor da super classe.
protected abstract boolean	throwsInterfaceExceptions() Indica se lança as exceções relacionadas na interface.
protected static void	usage() Exibe mensagem com instruções para execução da linha de comando.

Methods inherited from class java.lang.Object

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

Field Detail

interfaceName

protected String interfaceName

serviceClassName

protected String serviceClassName

genClassName

protected String genClassName

Constructor Detail

Generator

protected Generator(String interfaceName,
                    String serviceClassName,
                    String suffix)

Contrói uma instância do gerador.

Parameters:

interfaceName - nome completo da interface remota do serviço

serviceClassName - nome completo da classe que implementa o serviço

suffix - sufixo a acrescentar no nome da classe de serviço para formar o nome da classe gerada (Proxy, Unavailable, etc)

Method Detail

getPackageName

protected static String getPackageName(String className)

Obtém o nome do pacote de uma classe.

Parameters:

className - nome completo da class (incluindo pacote)

Returns:

o nome do pacote

getNoPackagesClassName

protected static String getNoPackagesClassName(String className)

Obtém o nome de uma classe, sem o pacote.

Parameters:

className - nome completo da class (incluindo pacote)

Returns:

o nome da classe sem o pacote

usage

protected static void usage()

Exibe mensagem com instruções para execução da linha de comando.

getBuffer

protected StringBuffer getBuffer()

Obtém o buffer que armazena o código.

Returns:

buffer com o código armazenado

generate

protected final void generate()
                       throws ClassNotFoundException

Gera o código fonte em um StringBuffer

Throws:

ClassNotFoundException - se a classe da interface remota não for encontrada

flushToFile

protected void flushToFile(StringBuffer code)

Descarrega o buffer para um arquivo. O arquivo contém a classe gerada, e será gravado na localização correspondente à mesma (isto é, obedecendo seu pacote).

Parameters:

code - .

invokesSuperClassConstructor

protected abstract boolean invokesSuperClassConstructor()

Indica se o construtor da classe gerada invoca o construtor da super classe.

Returns:

true se o construtor da super classe é invocado false caso contrário

throwsInterfaceExceptions

protected abstract boolean throwsInterfaceExceptions()

Indica se lança as exceções relacionadas na interface.

Returns:

true se as exceções são lançadas false caso contrário

getConstructorExceptions

protected String[] getConstructorExceptions()

Acrescenta exceções específicas a um construtor. Deve ser redefinida, se o construtor da classe tem exceções específicas.

Returns:

array com os nomes das exceções lançadas

getConstructorLines

protected abstract void getConstructorLines(StringBuffer code,
                                            String[] paremeterNames)

Acrescenta as linhas de código a um construtor.

Parameters:

code - buffer que armazena o código

paremeterNames - nomes dos parâmetros passados pelo construtor.

getMethodLines

protected abstract void getMethodLines(StringBuffer code,
                                       Method method,
                                       String[] parameterNames)

Acrescenta ao código a implementação de um método.

Parameters:

code - buffer que armazena o código

method - descrição do método a implementar

parameterNames - nomes dos parâmetros do método

getSuperClass

protected abstract Class getSuperClass()
                                throws ClassNotFoundException

Obtém a super classe da classe gerada.

Returns:

a super classe que o classe gerada irá estender.

Throws:

ClassNotFoundException - em caso de falha na super-classe

getSuperClassName

protected abstract String getSuperClassName()

Obtém o nome da super classe da classe gerada.

Returns:

o nome da super classe que o classe gerada irá estender.

getImports

protected abstract String[] getImports()

Obtém os pacotes a serem importados pela classe gerada.

Returns:

um array com strings que representam os pacotes a serem importados.