org.sandev.generator
Class XMLSerializerGenerator

java.lang.Object
  org.sandev.generator.GeneratorCommon
      org.sandev.generator.AggregateGeneratorBase
          org.sandev.generator.XMLSerializerGenerator

All Implemented Interfaces:

org.sandev.sandbuild.SandGenerator

public class XMLSerializerGenerator
extends org.sandev.generator.AggregateGeneratorBase
implements org.sandev.sandbuild.SandGenerator

Write the XMLSerializer source file

Field Summary

static java.lang.String[]	MISCEXTRAMSG Other messages and interfaces that we need to know about, but are not directly supported for aggregate references within a struct message.
static java.lang.String[]	SUPIFACES Interfaces that serve as common superclasses for several objects.

Fields inherited from class org.sandev.generator.AggregateGeneratorBase

extra

Fields inherited from class org.sandev.generator.GeneratorCommon

CONTEXT_CONFIGURATION, CONTEXT_CONTROL, CONTEXT_FRAMEWORK, CONTEXT_MESSAGING, CONTEXT_PERSISTENCE, CONTEXT_UI, DEFAULT_LINE_LENGTH, MESSAGE_INTERFACES

Constructor Summary

XMLSerializerGenerator()

Method Summary

protected java.lang.String	getFileSpec(java.io.File baseDir) Return lastApp/src/org/xyz/util/XMLSerializer.java or the equivalent filespec for the given triggering build.
protected boolean	isGeneralClassInterface(java.lang.String className) Return true if the given class name is one of the general message interfaces defined in basic structs.
protected void	writeBasicFieldDumpCode(java.io.PrintStream out, com.sun.javadoc.FieldDoc fd) Write code to dump out this field as a basic type
protected void	writeBasicFieldReadCode(java.io.PrintStream out, com.sun.javadoc.FieldDoc fd) Mirror of writeBasicFieldDumpCode
protected void	writeClassFieldDumpCode(java.io.PrintStream out, com.sun.javadoc.FieldDoc fd) Write code to dump out this field as a class type
protected void	writeClassFieldReadCode(java.io.PrintStream out, com.sun.javadoc.FieldDoc fd) Mirror of writeClassFieldDumpCode
protected void	writeDumpArrayMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Write out a specific array method dumper
protected void	writeDumpArrayMethod(java.io.PrintStream out, java.lang.String className)
protected void	writeDumpCollectionMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Write out a specific method collection dumper
protected void	writeDumpIfaceArrayMethods(java.io.PrintStream out)
protected void	writeDumpMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Write out a specific method dumper
protected void	writeDumpMethods(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls) Write out the message dumpers.
protected void	writeDumpQueryMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Write out a specific method query dumper
protected void	writeDumpRootMethod(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls)
protected void	writeDumpUpdateMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Write out a specific method update dumper
protected void	writeFile(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls) Write the XMLSerializer source file
protected void	writeHTMLEncode(java.io.PrintStream out) The htmlEncode method is not the same as the org.sandev.doclet.StringUtils rangeEscape processing in the basics project since it has to deal with a variety of characters beyond just greater-than and less-than.
protected void	writeIfaceReaders(java.io.PrintStream out)
protected void	writeLoadArrayMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd) Mirror of writeDumpArrayMethod
protected void	writeLoadArrayMethod(java.io.PrintStream out, java.lang.String className)
protected void	writeLoadArraySwitch(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls)
protected void	writeLoadCollectionMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd)
protected void	writeLoadIfaceArrayMethods(java.io.PrintStream out)
protected void	writeLoadMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd)
protected void	writeLoadMethods(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls) Write out the message loaders.
protected void	writeLoadQueryMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd)
protected void	writeLoadSwitch(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls)
protected void	writeLoadUpdateMethod(java.io.PrintStream out, com.sun.javadoc.ClassDoc cd)
protected void	writePostamble(java.io.PrintStream out) Write the end of the file.
protected void	writePreamble(java.io.PrintStream out, org.sandev.sandbuild.SandDecl[] decls) Write the beginning of the file.
protected void	writeTokenUtilityMethods(java.io.PrintStream out)

Methods inherited from class org.sandev.generator.AggregateGeneratorBase

addSandAttrValToDecls, cleanup, cleanupSecondaryFiles, generate, getExtra, setExtra, writeSecondaryFiles

Methods inherited from class org.sandev.generator.GeneratorCommon

capitalize, copyfile, deletefile, filterHTMLLine, findStructDeclByShortname, getDeclaredFields, getFields, getInheritanceHierarchy, getLastAppProject, getLastUtilDir, getLongInstanceName, getPrintStream, getSandProject, getShortInstanceName, getUtilPackage, getVisibleFields, hasSubStructs, isArray, isBasic, isLongReferenceArray, isMessageInterface, isParentAbstract, isPrimitive, isRootStruct, isVowel, log, nextToken, pluralize, rangeEscape, removePlatformDecls, trackFileDelete, trackFileWrite, uncapitalize, writeDefaultCtor, writeDescription, writeHTMLContents, writeMessageImports, writeSectionName, writeStandardCommentID, writeXHTMLFooter, writeXHTMLFooter, writeXHTMLHeader, writeXHTMLHeader

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sandev.sandbuild.SandGenerator

cleanup, generate

Field Detail

SUPIFACES

public static final java.lang.String[] SUPIFACES

Interfaces that serve as common superclasses for several objects.

MISCEXTRAMSG

public static final java.lang.String[] MISCEXTRAMSG

Other messages and interfaces that we need to know about, but are not directly supported for aggregate references within a struct message.

Constructor Detail

XMLSerializerGenerator

public XMLSerializerGenerator()

Method Detail

getFileSpec

protected java.lang.String getFileSpec(java.io.File baseDir)
                                throws org.sandev.sandbuild.SandGeneratorException

Return lastApp/src/org/xyz/util/XMLSerializer.java or the equivalent filespec for the given triggering build. The given baseDir is ignored.

Overrides:

getFileSpec in class org.sandev.generator.AggregateGeneratorBase

Throws:

org.sandev.sandbuild.SandGeneratorException

writeFile

protected void writeFile(java.io.PrintStream out,
                         org.sandev.sandbuild.SandDecl[] decls)
                  throws org.sandev.sandbuild.SandGeneratorException

Write the XMLSerializer source file

Overrides:

writeFile in class org.sandev.generator.AggregateGeneratorBase

Throws:

org.sandev.sandbuild.SandGeneratorException

writePreamble

protected void writePreamble(java.io.PrintStream out,
                             org.sandev.sandbuild.SandDecl[] decls)
                      throws org.sandev.sandbuild.SandGeneratorException

Write the beginning of the file.

Throws:

org.sandev.sandbuild.SandGeneratorException

writePostamble

protected void writePostamble(java.io.PrintStream out)

Write the end of the file.

writeDumpRootMethod

protected void writeDumpRootMethod(java.io.PrintStream out,
                                   org.sandev.sandbuild.SandDecl[] decls)

writeDumpMethods

protected void writeDumpMethods(java.io.PrintStream out,
                                org.sandev.sandbuild.SandDecl[] decls)

Write out the message dumpers.

writeDumpMethod

protected void writeDumpMethod(java.io.PrintStream out,
                               com.sun.javadoc.ClassDoc cd)

Write out a specific method dumper

writeBasicFieldDumpCode

protected void writeBasicFieldDumpCode(java.io.PrintStream out,
                                       com.sun.javadoc.FieldDoc fd)

Write code to dump out this field as a basic type

writeClassFieldDumpCode

protected void writeClassFieldDumpCode(java.io.PrintStream out,
                                       com.sun.javadoc.FieldDoc fd)

Write code to dump out this field as a class type

writeDumpArrayMethod

protected void writeDumpArrayMethod(java.io.PrintStream out,
                                    com.sun.javadoc.ClassDoc cd)

Write out a specific array method dumper

writeDumpArrayMethod

protected void writeDumpArrayMethod(java.io.PrintStream out,
                                    java.lang.String className)

writeDumpUpdateMethod

protected void writeDumpUpdateMethod(java.io.PrintStream out,
                                     com.sun.javadoc.ClassDoc cd)

Write out a specific method update dumper

writeDumpQueryMethod

protected void writeDumpQueryMethod(java.io.PrintStream out,
                                    com.sun.javadoc.ClassDoc cd)

Write out a specific method query dumper

writeDumpCollectionMethod

protected void writeDumpCollectionMethod(java.io.PrintStream out,
                                         com.sun.javadoc.ClassDoc cd)

Write out a specific method collection dumper

writeDumpIfaceArrayMethods

protected void writeDumpIfaceArrayMethods(java.io.PrintStream out)

writeLoadMethods

protected void writeLoadMethods(java.io.PrintStream out,
                                org.sandev.sandbuild.SandDecl[] decls)

Write out the message loaders.

writeIfaceReaders

protected void writeIfaceReaders(java.io.PrintStream out)

writeLoadSwitch

protected void writeLoadSwitch(java.io.PrintStream out,
                               org.sandev.sandbuild.SandDecl[] decls)

writeLoadArraySwitch

protected void writeLoadArraySwitch(java.io.PrintStream out,
                                    org.sandev.sandbuild.SandDecl[] decls)

writeLoadMethod

protected void writeLoadMethod(java.io.PrintStream out,
                               com.sun.javadoc.ClassDoc cd)

writeBasicFieldReadCode

protected void writeBasicFieldReadCode(java.io.PrintStream out,
                                       com.sun.javadoc.FieldDoc fd)

Mirror of writeBasicFieldDumpCode

writeClassFieldReadCode

protected void writeClassFieldReadCode(java.io.PrintStream out,
                                       com.sun.javadoc.FieldDoc fd)

Mirror of writeClassFieldDumpCode

isGeneralClassInterface

protected boolean isGeneralClassInterface(java.lang.String className)

Return true if the given class name is one of the general message interfaces defined in basic structs.

writeLoadArrayMethod

protected void writeLoadArrayMethod(java.io.PrintStream out,
                                    com.sun.javadoc.ClassDoc cd)

Mirror of writeDumpArrayMethod

writeLoadArrayMethod

protected void writeLoadArrayMethod(java.io.PrintStream out,
                                    java.lang.String className)

writeLoadUpdateMethod

protected void writeLoadUpdateMethod(java.io.PrintStream out,
                                     com.sun.javadoc.ClassDoc cd)

writeLoadQueryMethod

protected void writeLoadQueryMethod(java.io.PrintStream out,
                                    com.sun.javadoc.ClassDoc cd)

writeLoadCollectionMethod

protected void writeLoadCollectionMethod(java.io.PrintStream out,
                                         com.sun.javadoc.ClassDoc cd)

writeLoadIfaceArrayMethods

protected void writeLoadIfaceArrayMethods(java.io.PrintStream out)

writeTokenUtilityMethods

protected void writeTokenUtilityMethods(java.io.PrintStream out)

writeHTMLEncode

protected void writeHTMLEncode(java.io.PrintStream out)

The htmlEncode method is not the same as the org.sandev.doclet.StringUtils rangeEscape processing in the basics project since it has to deal with a variety of characters beyond just greater-than and less-than.