org.netbeans.modules.schema2beansdev

Class BeanClass

java.lang.Object

org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass

org.netbeans.modules.schema2beansdev.BeanClass

All Implemented Interfaces:

CodeGeneratorClass

public class BeanClass
extends AbstractCodeGeneratorClass
implements CodeGeneratorClass

This class generates the bean classes code. There is one instance of this class per bean to generate. The BeanBuilder creates one instance of the BeanClass class for every bean class to generate, and for each of these instances, the BeanBuilder calls the addPropertyMethod() in order to populate the list of properties contained by the bean. Then it calls the process() method, which makes the class to generate its java output into the output stream specified in the process parameter. The BeanBuilder might give an optional MetaDD bean graph which contains extra information that didn't exist in the dtd. The content of this graph is used to generate extra information about the properties of the bean (for example the default values, well known values, wrapper class)

Nested Class Summary

Nested classes/interfaces inherited from class org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass

AbstractCodeGeneratorClass.Signature, AbstractCodeGeneratorClass.Signatures

Field Summary

Fields inherited from class org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass

ACCESS_SECTION, ADD, arrKeywords, attrList, beanElement, BODY_SECTION, BOOLEAN, CLASS, className, config, CONSTRUCTOR_SECTION, DECL_SECTION, EQUALS_SECTION, FINAL, fullClassName, generatedNewMethods, GETTER, GETTERINDEXED, GETTERLIST, HASHCODE_SECTION, HEADER_SECTION, IMPORT, INITIALIZE_SECTION, INT, MAX_DUMP_TREE_LINE_COUNT, MAXVALUE, mdd, metaElement, NEW_METHOD_SECTION, OTHER, PACKAGE, packageName, prefixGuesser, PRIVATE, PROTECTED, PUBLIC, REMOVE, rootBeanElement, SETTER, SETTERINDEXED, SIZE, STATIC, STRING, TRAILER_SECTION, VOID

Method Summary

Modifier and Type	Method and Description
protected void	addExtraMethods()
void	generate(OutputStream out, MetaDD mdd) Generate the java code in the out stream, using the optional metaDD bean graph.
protected void	genValidateFail(String detail, String name, boolean quoteDetail, ValidateException.FailureType ft, JavaWriter out)
void	setInvalidPropertyNames(Map invalidNames) The generator should put in an entry for every name that is invalid to use as a property name.
protected String	testIfPropertyNotSet(org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass.Property prop)
protected String	testIfPropertySet(org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass.Property prop)

Methods inherited from class org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass

addProperty, beanTree, begin, beginNoI18N, comment, comment, comment, commonBeanType, countNumberOfNonAttributeProperties, countNumberOfNonAttributePropertiesRecurse, cr, dumpAttributes, dumpBeanTree, dumpBeanTree, end, end, endNoI18N, eol, eol, eolNoI18N, findAttributeOwners, findProperty, firstInCommaSeparatedList, gen, gen, gen, gen, gen, gen, gen, gen, gen, gen, gen, gen, genCopy, genCopyWillCopy, gencr, gencr, gencr, gencr, gencr, gencr, gencr, gencrNoI18N, gencrNoI18N, genDefaultsAccessable, geneol, generate, generateDelegator, generateDelegator, generateDelegatorConstructors, generateSwitches, genforprop, genForRestrictions, gengetprop, gengetpropbyname, genInvalidName, genNewDefault, genNewMethod, genNewMethod, genResetMutuallyExclusive, genRethrowExceptions, genSetValP, genSetValue, gensig1, gensig2, gentab, genValidateIf, genValidateProperties, genWhiteSpaceRestriction, get, getDefaultNamespace, getGeneratedMethods, geti, getidx, getMetaElement, getMetaElement, getMetaElement, getMetaProperty, getMetaProperty, getPropertyList, getRootClassName, getSignatures, getTypeFullClassName, getTypeFullClassName, hasDeepCopyConstructor, init, isCloneCallNeededOnType, isMutableType, isMutuallyExclusive, isTypeQName, noI18N, parentBeanType, PC, PO, printComment, printGenBuffers, printSchema, resetGenBuffers, select, setDefaultNamespace, setIndent, setPackageName, setPrefixGuesser, setRootBeanElement, sp, tabIn, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.modules.schema2beansdev.CodeGeneratorClass

addProperty, dumpBeanTree, generate, generateDelegator, getGeneratedMethods, getPropertyList, setDefaultNamespace, setIndent, setPackageName, setPrefixGuesser, setRootBeanElement

Method Detail

genValidateFail

protected void genValidateFail(String detail,
                               String name,
                               boolean quoteDetail,
                               ValidateException.FailureType ft,
                               JavaWriter out)
                        throws IOException

Specified by:

genValidateFail in class AbstractCodeGeneratorClass

Throws:

IOException

generate

public void generate(OutputStream out,
                     MetaDD mdd)
              throws IOException

Generate the java code in the out stream, using the optional metaDD bean graph.

Specified by:

generate in interface CodeGeneratorClass

Specified by:

generate in class AbstractCodeGeneratorClass

Throws:

IOException

addExtraMethods

protected void addExtraMethods()

setInvalidPropertyNames

public void setInvalidPropertyNames(Map invalidNames)

Description copied from interface: CodeGeneratorClass

The generator should put in an entry for every name that is invalid to use as a property name.

Specified by:

setInvalidPropertyNames in interface CodeGeneratorClass

Parameters:

invalidNames - is a Map where they key is the invalid name and the value (BeanElement) is most likely null. For instance, anything that inherits from java.lang.Object will not be able to generate a getClass method, so the property named "Class" is invalid. Typically, the invalid method names are due to a parent class already having a method of that name with the same parameters (overloading is okay though). A property X is invalid if a parent class already has a getX(); and if X might ever be an array, then also getX(int) or sizeX().

testIfPropertySet

protected String testIfPropertySet(org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass.Property prop)

Overrides:

testIfPropertySet in class AbstractCodeGeneratorClass

testIfPropertyNotSet

protected String testIfPropertyNotSet(org.netbeans.modules.schema2beansdev.AbstractCodeGeneratorClass.Property prop)

Overrides:

testIfPropertyNotSet in class AbstractCodeGeneratorClass