org.apache.axis.wsdl.toJava

Class JavaClassWriter

public abstract class JavaClassWriter extends JavaWriter

Emitter knows about WSDL writers, one each for PortType, Binding, Service, Definition, Type. But for some of these WSDL types, Wsdl2java generates multiple files. Each of these files has a corresponding writer that extends JavaWriter. So the Java WSDL writers (JavaPortTypeWriter, JavaBindingWriter, etc.) each calls a file writer (JavaStubWriter, JavaSkelWriter, etc.) for each file that that WSDL generates.

For example, when Emitter calls JavaWriterFactory for a Binding Writer, it returns a JavaBindingWriter. JavaBindingWriter, in turn, contains a JavaStubWriter, JavaSkelWriter, and JavaImplWriter since a Binding may cause a stub, skeleton, and impl template to be generated.

Note that the writers that are given to Emitter by JavaWriterFactory DO NOT extend JavaWriter. They simply implement Writer and delegate the actual task of writing to extensions of JavaWriter.

All of Wsdl2java's Writer implementations follow a common behaviour. JavaWriter is the abstract base class that dictates this common behaviour. Many of the files generated are .java files, so this abstract class - JavaClassWriter - exists. It extends JavaWriter and adds a bit of Java- relative behaviour. This behaviour is primarily placed within the generate method. The generate method calls, in succession (note: the starred methods are the ones you are probably most interested in):

getFileName
This method is abstract in JavaWriter, but JavaClassWriter implements this method. Subclasses should have no need to override it. It returns the fully-qualified file name based on the fully-qualified classname + ".java".
isFileGenerated(file)
You should not need to override this method. It checks to see whether this file is in the List returned by emitter.getGeneratedFileNames.
registerFile(file)
You should not need to override this method. It registers this file by calling emitter.getGeneratedFileInfo().add(...).
* verboseMessage(file)
You may override this method if you want to provide more information. The generate method only calls verboseMessage if verbose is turned on.
getPrintWriter(file)
You should not need to override this method. Given the file name, it creates a PrintWriter for it.
writeFileHeader(pw)
JavaClassWriter implements this method, so you should not need to override it. This method generates a javadoc giving the filename and a comment stating that this file is generated by WSDL2Java, and it generates the class definition including the opening curly brace..
* writeFileBody(pw)
This is an abstract method that must be implemented by the subclass. This is where the body of a file is generated.
* writeFileFooter(pw)
JavaClassWriter implements this method, so you should not need to override it. It generates the closing curly brace for the class.
closePrintWriter(pw)
You should not need to override this method. It simply closes the PrintWriter.

Additional behaviour that JavaClassWriter introduces beyond JavaWriter is related to the class header and definition:

writeHeaderComments
Write the header comments, such as the file name and that the file was generated by WSDL2Java. You need not override this method unless you want a tailored comment.
writePackage
Write the package statement, if necessary. You should not need to override this method.
getClassModifiers
Modifiers, such as "public", "final", "abstract" would be returned by this method. The default implementation only generates "public ", so any subclass that needs more must override this method.
getClassText
This simply returns "class ". If anything else is desired, for instance, JavaInterfaceWriter prefers "interface ", then this method must be overridden.
getExtendsText
The default implementation returns "". If a subclass desires to list a set of classes this one extends, then this method must be overridden.
getImplementsText
Same as getExtendsText except for the implements clause.
Field Summary
protected StringclassName
Field className
protected Namespacesnamespaces
Field namespaces
protected StringpackageName
Field packageName
Constructor Summary
protected JavaClassWriter(Emitter emitter, String fullClassName, String type)
Constructor.
Method Summary
protected StringgetClassModifiers()
Return "public ".
protected StringgetClassName()
Returns the class name.
protected StringgetClassText()
Return "class ".
protected StringgetExtendsText()
Returns the appropriate extends clause.
protected StringgetFileName()
Return the file name as a string of the form: ".java"
protected StringgetImplementsText()
Returns the appropriate implements clause.
protected StringgetPackage()
Returns the package name.
protected voidregisterFile(String file)
You should not need to override this method.
protected voidwriteFileFooter(PrintWriter pw)
Generate the closing curly brace.
protected voidwriteFileHeader(PrintWriter pw)
Write a common header, including the package name, the class declaration, and the opening curly brace.
protected voidwriteHeaderComments(PrintWriter pw)
Write the header comments.
protected voidwritePackage(PrintWriter pw)
Write the package declaration statement.

Field Detail

className

protected String className
Field className

namespaces

protected Namespaces namespaces
Field namespaces

packageName

protected String packageName
Field packageName

Constructor Detail

JavaClassWriter

protected JavaClassWriter(Emitter emitter, String fullClassName, String type)
Constructor.

Parameters: emitter The emitter instance fullClassName The fully qualified class name of the class to be generated. type

Method Detail

getClassModifiers

protected String getClassModifiers()
Return "public ". If more modifiers are needed, this method must be overridden.

Returns:

getClassName

protected String getClassName()
Returns the class name.

Returns:

getClassText

protected String getClassText()
Return "class ". If "interface " is needed instead, this method must be overridden.

Returns:

getExtendsText

protected String getExtendsText()
Returns the appropriate extends clause. This default implementation simply returns "", but if you want "extends " then you must override this method.

Returns: ""

getFileName

protected String getFileName()
Return the file name as a string of the form: ".java"

Returns:

getImplementsText

protected String getImplementsText()
Returns the appropriate implements clause. This default implementation simply returns "", but if you want "implements " then you must override this method.

Returns: ""

getPackage

protected String getPackage()
Returns the package name.

Returns:

registerFile

protected void registerFile(String file)
You should not need to override this method. It registers the given file by calling emitter.getGeneratedFileInfo().add(...). JavaClassWriter overrides this method from JavaWriter because it add class name to the registration information.

Parameters: file

writeFileFooter

protected void writeFileFooter(PrintWriter pw)
Generate the closing curly brace.

Parameters: pw

Throws: IOException

writeFileHeader

protected void writeFileHeader(PrintWriter pw)
Write a common header, including the package name, the class declaration, and the opening curly brace.

Parameters: pw

Throws: IOException

writeHeaderComments

protected void writeHeaderComments(PrintWriter pw)
Write the header comments.

Parameters: pw

Throws: IOException

writePackage

protected void writePackage(PrintWriter pw)
Write the package declaration statement.

Parameters: pw

Throws: IOException

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.