JavaBeanHelperWriter (Apache Axis)

java.lang.Object
- org.apache.axis.wsdl.toJava.JavaWriter
- - org.apache.axis.wsdl.toJava.JavaClassWriter
  - - org.apache.axis.wsdl.toJava.JavaBeanHelperWriter

All Implemented Interfaces:

Generator
```
public class JavaBeanHelperWriter
extends JavaClassWriter
```
This is Wsdl2java's Helper Type Writer. It writes the .java file.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Vector`	`attributes` Field attributes
`protected boolean`	`canSearchParents` Field canSearchParents
`protected Vector`	`elementMetaData` Field elementMetaData
`protected Vector`	`elements` Field elements
`protected TypeEntry`	`extendType` Field extendType
`protected Set`	`reservedPropNames` Field reservedPropNames
`protected TypeEntry`	`type` Field type
`protected PrintWriter`	`wrapperPW` Field wrapperPW

Fields inherited from class org.apache.axis.wsdl.toJava.JavaClassWriter
className, namespaces, packageName

Fields inherited from class org.apache.axis.wsdl.toJava.JavaWriter
emitter, LINE_LENGTH

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`JavaBeanHelperWriter(Emitter emitter, TypeEntry type, Vector elements, TypeEntry extendType, Vector attributes, Set reservedPropNames)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`closePrintWriter(PrintWriter pw)` Only close the PrintWriter if the PrintWriter belongs to this class.
`protected PrintWriter`	`getPrintWriter(String filename)` The default behaviour (of super.getPrintWriter) is, given the file name, create a PrintWriter for it.
`protected void`	`registerFile(String file)` Only register the filename if the bean helper is not wrapped within a bean.
`protected void`	`setPrintWriter(PrintWriter pw)` The bean helper class may be its own class, or it may be embedded within the bean class.
`protected String`	`verboseMessage(String file)` Return the string: "Generating ".
`protected void`	`writeDeserializer(PrintWriter pw)` write Deserializer getter code and pass in meta data to avoid undo introspection.
`protected void`	`writeFileBody(PrintWriter pw)` Generate the file body for the bean helper.
`protected void`	`writeFileFooter(PrintWriter pw)` Only write the file footer if the bean helper is not wrapped within a bean.
`protected void`	`writeFileHeader(PrintWriter pw)` Only write the file header if the bean helper is not wrapped within a bean.
`protected void`	`writeMetaData(PrintWriter pw)` write MetaData code
`protected void`	`writeSerializer(PrintWriter pw)` write Serializer getter code and pass in meta data to avoid undo introspection.

Methods inherited from class org.apache.axis.wsdl.toJava.JavaClassWriter
getClassModifiers, getClassName, getClassText, getExtendsText, getFileName, getImplementsText, getPackage, writeHeaderComments, writePackage

Methods inherited from class org.apache.axis.wsdl.toJava.JavaWriter
generate, getJavadocDescriptionPart, isFileGenerated, writeComment, writeComment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
protected TypeEntry type
```
    Field type
  - elements
```
protected Vector elements
```
    Field elements
  - attributes
```
protected Vector attributes
```
    Field attributes
  - extendType
```
protected TypeEntry extendType
```
    Field extendType
  - wrapperPW
```
protected PrintWriter wrapperPW
```
    Field wrapperPW
  - elementMetaData
```
protected Vector elementMetaData
```
    Field elementMetaData
  - canSearchParents
```
protected boolean canSearchParents
```
    Field canSearchParents
  - reservedPropNames
```
protected Set reservedPropNames
```
    Field reservedPropNames
- Constructor Detail
  - JavaBeanHelperWriter
```
protected JavaBeanHelperWriter(Emitter emitter,
                    TypeEntry type,
                    Vector elements,
                    TypeEntry extendType,
                    Vector attributes,
                    Set reservedPropNames)
```
    Constructor.
    
    Parameters:
    emitter -
    type - The type representing this class
    elements - Vector containing the Type and name of each property
    extendType - The type representing the extended class (or null)
    attributes - Vector containing the attribute types and names
- Method Detail
  - setPrintWriter
```
protected void setPrintWriter(PrintWriter pw)
```
    The bean helper class may be its own class, or it may be embedded within the bean class. If it's embedded within the bean class, the JavaBeanWriter will set JavaBeanHelperWriter's PrintWriter to its own.
    
    Parameters:
    pw -
  - getPrintWriter
```
protected PrintWriter getPrintWriter(String filename)
                              throws IOException
```
    The default behaviour (of super.getPrintWriter) is, given the file name, create a PrintWriter for it. If the bean helper that this class is generating is embedded within a bean, then the PrintWriter returned by this method is the JavaBeanWriter's PrintWriter. Otherwise super.getPrintWriter is called.
    
    Overrides:
    
    getPrintWriter in class JavaWriter
    
    Parameters:
    filename -
    
    Returns:
    
    Throws:
    
    IOException
  - registerFile
```
protected void registerFile(String file)
```
    Only register the filename if the bean helper is not wrapped within a bean.
    
    Overrides:
    
    registerFile in class JavaClassWriter
    
    Parameters:
    file -
  - verboseMessage
```
protected String verboseMessage(String file)
```
    Return the string: "Generating ". only if we are going to generate a new file.
    
    Overrides:
    
    verboseMessage in class JavaWriter
    
    Parameters:
    file -
    
    Returns:
  - writeFileHeader
```
protected void writeFileHeader(PrintWriter pw)
                        throws IOException
```
    Only write the file header if the bean helper is not wrapped within a bean.
    
    Overrides:
    
    writeFileHeader in class JavaClassWriter
    
    Parameters:
    pw -
    
    Throws:
    
    IOException
  - writeFileBody
```
protected void writeFileBody(PrintWriter pw)
                      throws IOException
```
    Generate the file body for the bean helper.
    
    Specified by:
    
    writeFileBody in class JavaWriter
    
    Parameters:
    pw -
    
    Throws:
    
    IOException
  - writeFileFooter
```
protected void writeFileFooter(PrintWriter pw)
                        throws IOException
```
    Only write the file footer if the bean helper is not wrapped within a bean.
    
    Overrides:
    
    writeFileFooter in class JavaClassWriter
    
    Parameters:
    pw -
    
    Throws:
    
    IOException
  - closePrintWriter
```
protected void closePrintWriter(PrintWriter pw)
```
    Only close the PrintWriter if the PrintWriter belongs to this class. If the bean helper is embedded within a bean then the PrintWriter belongs to JavaBeanWriter and THAT class is responsible for closing the PrintWriter.
    
    Overrides:
    
    closePrintWriter in class JavaWriter
    
    Parameters:
    pw -
  - writeMetaData
```
protected void writeMetaData(PrintWriter pw)
                      throws IOException
```
    write MetaData code
    
    Parameters:
    pw -
    
    Throws:
    
    IOException
  - writeSerializer
```
protected void writeSerializer(PrintWriter pw)
                        throws IOException
```
    write Serializer getter code and pass in meta data to avoid undo introspection.
    
    Parameters:
    pw -
    
    Throws:
    
    IOException
  - writeDeserializer
```
protected void writeDeserializer(PrintWriter pw)
                          throws IOException
```
    write Deserializer getter code and pass in meta data to avoid undo introspection.
    
    Parameters:
    pw -
    
    Throws:
    
    IOException

Class JavaBeanHelperWriter

Field Summary

Fields inherited from class org.apache.axis.wsdl.toJava.JavaClassWriter

Fields inherited from class org.apache.axis.wsdl.toJava.JavaWriter

Constructor Summary

Method Summary

Methods inherited from class org.apache.axis.wsdl.toJava.JavaClassWriter

Methods inherited from class org.apache.axis.wsdl.toJava.JavaWriter

Methods inherited from class java.lang.Object

Field Detail

type

elements

attributes

extendType

wrapperPW

elementMetaData

canSearchParents

reservedPropNames

Constructor Detail

JavaBeanHelperWriter

Method Detail

setPrintWriter

getPrintWriter

registerFile

verboseMessage

writeFileHeader

writeFileBody

writeFileFooter

closePrintWriter

writeMetaData

writeSerializer

writeDeserializer