GenJavaOutClass

java.lang.Object
- org.vishia.genJavaOutClass.GenJavaOutClass

```
public final class GenJavaOutClass
extends java.lang.Object
```
Basic functionality to generate a Java class proper for storing results from Zbnf parser and from XmlJzReader. This class is used from GenZbnfJavaData and from GenXmlCfgJavaData. For generating the source the OutTextPreparer is used. It means the sources are given as templates, one for each part.

Comparison OutTextPreparer with the JZtxtcmd script executer:
The OutTextPreparer is similar the JZtxtcmd but more simple in execution. For JZtxtcmd the template for the sources is really given in a textual file. Here the template for the sources are contained in this class as Strings. It may be possible to read the Strings from a file, for more flexibility to change the sources.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GenJavaOutClass.CmdArgs` Command line args
`static class`	`GenJavaOutClass.SubClassField`
`static class`	`GenJavaOutClass.SubClassJava` Instances of this class describe a sub class in generated code.
`class`	`GenJavaOutClass.WrClassJava`

Field Summary

Fields
Modifier and Type	Field and Description
`protected GenJavaOutClass.CmdArgs`	`cmdArgs` Command line args
`java.util.Map<java.lang.String,GenJavaOutClass.SubClassJava>`	`idxRegisteredCmpn` Index of already registered components to add in `listCmpn` only one time.
`java.util.TreeMap<java.lang.String,java.lang.String>`	`idxStdTypes` StandardTypes.
`java.util.List<GenJavaOutClass.SubClassJava>`	`listCmpn` The syntax components which are to process yet (are used for parse result storing).
`protected LogMessage`	`log`
`protected static java.util.Map<java.lang.String,java.lang.String>`	`reservedNames`
`private OutTextPreparer`	`sJavaHeadZbnf` Text for Java header for Zbnf writer class.
`protected OutTextPreparer`	`sJavaMetaClass`
`protected OutTextPreparer`	`sJavaMetaClassOper`
`protected java.lang.String`	`sJavaOutputDir`
`(package private) java.util.Map<java.lang.String,java.lang.String>`	`superTypes`
`static java.lang.String`	`sVersion` Version, history and license.
`protected OutTextPreparer`	`tJavaCmpnClass_Base` Text for class header for syntax component data storing.
`protected OutTextPreparer`	`tJavaCmpnClassUsg` Text for class header for syntax component to write from zbnf.
`protected OutTextPreparer`	`tJavaCmpnClassZbnf` Text for class header for syntax component to write from zbnf.
`protected static java.lang.String`	`tJavaCmpnEnd`
`protected OutTextPreparer`	`tJavaCmpnZbnf`
`protected static java.lang.String`	`tJavaEnd`
`protected OutTextPreparer`	`tJavaHeadBase` Text for Java header.
`private OutTextPreparer`	`tJavaHeadUsg` Text for Java usage header.
`protected OutTextPreparer`	`tJavaListAllVar`
`protected OutTextPreparer`	`tJavaListCmpnZbnf`
`protected OutTextPreparer`	`tJavaListVar`
`protected OutTextPreparer`	`tJavaListVarOper`
`protected OutTextPreparer`	`tJavaListVarZbnf`
`protected OutTextPreparer`	`tJavaMetaClassZbnf`
`protected OutTextPreparer`	`tJavaSimpleVar`
`protected OutTextPreparer`	`tJavaSimpleVarOper`
`protected OutTextPreparer`	`tJavaSimpleVarZbnf` typeNs: null on simple types as String, int.
`protected OutTextPreparer`	`tJavaSuperTypeClass` Text for class header for syntax component data storing.
`protected java.io.Writer`	`wr`
`protected java.io.Writer`	`wru` Writer for the base data class and the Zbnf JavaOut class.
`protected java.io.Writer`	`wrz` Writer for the base data class and the Zbnf JavaOut class.

Constructor Summary

Constructors
Constructor and Description

GenJavaOutClass(GenJavaOutClass.CmdArgs args, LogMessage log)

Constructors
Constructor and Description
`GenJavaOutClass(GenJavaOutClass.CmdArgs args, LogMessage log)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeWrite()`
`static java.lang.String`	`convertToIdentifier(java.lang.String src)`
`void`	`finishClassWrite()`
`void`	`finishCmpnWrite()`
`static java.lang.String`	`firstLowercaseIdentifier(java.lang.String src)`
`static java.lang.String`	`firstUppercaseIdentifier(java.lang.String src)`
`void`	`setupWriter()`

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

- Field Detail
  - sVersion
```
public static final java.lang.String sVersion
```
    Version, history and license.
    - 2024-05-24 Warning-free without changes
    - 2024-05-08 In all otx scripts now generates a comment line in the Java src which script is used there. Starts with //otx-Template
    - 2024-05-08: new convertToIdentifier(String) because in odt files text:s is used etc. , the name space was not regarded till now.
    - 2024-05-08 in tJavaCmpnClassUsg: use "<:&dataClass>_Base" instead "JavaSrc_Base", old manual after generation fixed mistake
    - 2024-05-08 some formally changes, using this. etc.
    - 2022-06-01 Hartmut: instead "JavaSrc" (special usage) generate name of the correct frame class.
    - 2022-03-28 Hartmut: Now line and column is written in own super class SrcInfo. This can be used by applications to get line and column info independent of the parse result. Very important. It is changed in this generator. The class SrcInfo is new.
    - 2022-02-28 Hartmut: Now creates three files. Docu is todo. The third file is especially user-changable, it is only a template.
    - 2022-02-20 Hartmut: in GenJavaOutClass.CmdArgs.fileOutStruct: for argument output the struct. See org.vishia.parseJava.JavaParser and ZbnfParser.writeSyntaxStruct(Appendable).
    - 2022-02-18 Hartmut: adding the SetLineColumn_ifc to the output classes. This is important to get the source information while using the parse result. It is a general property from now. The basics to write the information are contained in ZbnfJavaOutput since 2014-05, used for manual written files. Now also for the generated ones. For other outputs (XML) it should be supplemented.
    - 2022-02-18 Hartmut: Improvements for basic types, now proper without manual corrections: The typeNs argument should be null for basic types. It is tested. The value of typeNs is yet not used, here some improvement opportunities.
    - 2022-02-11 Hartmut Generally change: Now no inheritance between writing class (..._Zbnf) instead referencing of the data class. In this kind a writing class can be also derived from another writing class as well as the data class can have its own inheritance. The inheritance of data classes is a new feature also introduced in the last version, but it was not sufficient without this change. Some else experience in this code.
    - 2022-02-10 Hartmut
      option -all, then writes classes from all syntax components. (Else, compatible version, writes only from used ones). This is necessary if super components are used, which are not written elsewhere. Usually there should not exist unnecessary non used components
      Using flush, hence output can be checked. It is very helpfully.
      Some fine tuning for super components, should be compatible with older usages. (compare it before use)
    - 2022-02-07 Hartmut identifier-name replaced by identifier_name. Used for org.vishia.parseJava.JavaContent
    - 2019-08-17 Hartmut only comments
    - 2019-08-17 Hartmut creation copied and reduced from GenZbnfJavaData. It is compare able with the last version from this class. Some changes made. Tested.
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - cmdArgs
```
protected final GenJavaOutClass.CmdArgs cmdArgs
```
    Command line args
  - log
```
protected final LogMessage log
```
  - wrz
```
protected java.io.Writer wrz
```
    Writer for the base data class and the Zbnf JavaOut class.
  - wru
```
protected java.io.Writer wru
```
    Writer for the base data class and the Zbnf JavaOut class.
  - wr
```
protected java.io.Writer wr
```
  - sJavaOutputDir
```
protected java.lang.String sJavaOutputDir
```
  - superTypes
```
java.util.Map<java.lang.String,java.lang.String> superTypes
```
  - idxStdTypes
```
public final java.util.TreeMap<java.lang.String,java.lang.String> idxStdTypes
```
    StandardTypes.
  - listCmpn
```
public java.util.List<GenJavaOutClass.SubClassJava> listCmpn
```
    The syntax components which are to process yet (are used for parse result storing).
  - idxRegisteredCmpn
```
public java.util.Map<java.lang.String,GenJavaOutClass.SubClassJava> idxRegisteredCmpn
```
    Index of already registered components to add in listCmpn only one time.
  - reservedNames
```
protected static final java.util.Map<java.lang.String,java.lang.String> reservedNames
```
  - tJavaHeadBase
```
protected final OutTextPreparer tJavaHeadBase
```
    Text for Java header.
  - tJavaHeadUsg
```
private final OutTextPreparer tJavaHeadUsg
```
    Text for Java usage header.
  - sJavaHeadZbnf
```
private final OutTextPreparer sJavaHeadZbnf
```
    Text for Java header for Zbnf writer class.
  - tJavaSuperTypeClass
```
protected final OutTextPreparer tJavaSuperTypeClass
```
    Text for class header for syntax component data storing.
  - tJavaCmpnClass_Base
```
protected final OutTextPreparer tJavaCmpnClass_Base
```
    Text for class header for syntax component data storing.
  - tJavaCmpnClassZbnf
```
protected final OutTextPreparer tJavaCmpnClassZbnf
```
    Text for class header for syntax component to write from zbnf.
  - tJavaCmpnClassUsg
```
protected final OutTextPreparer tJavaCmpnClassUsg
```
    Text for class header for syntax component to write from zbnf.
  - tJavaCmpnEnd
```
protected static final java.lang.String tJavaCmpnEnd
```
    See Also:
    
    Constant Field Values
  - tJavaEnd
```
protected static final java.lang.String tJavaEnd
```
    See Also:
    
    Constant Field Values
  - tJavaSimpleVar
```
protected final OutTextPreparer tJavaSimpleVar
```
  - tJavaListVar
```
protected final OutTextPreparer tJavaListVar
```
  - tJavaListAllVar
```
protected final OutTextPreparer tJavaListAllVar
```
  - tJavaSimpleVarOper
```
protected final OutTextPreparer tJavaSimpleVarOper
```
  - tJavaListVarOper
```
protected final OutTextPreparer tJavaListVarOper
```
  - tJavaSimpleVarZbnf
```
protected final OutTextPreparer tJavaSimpleVarZbnf
```
    - typeNs: null on simple types as String, int.
    - cmpnClass: The name of the syntax component. It builts the name of the data... variable too.
  - tJavaListVarZbnf
```
protected final OutTextPreparer tJavaListVarZbnf
```
  - tJavaCmpnZbnf
```
protected final OutTextPreparer tJavaCmpnZbnf
```
  - tJavaListCmpnZbnf
```
protected final OutTextPreparer tJavaListCmpnZbnf
```
  - sJavaMetaClass
```
protected final OutTextPreparer sJavaMetaClass
```
  - sJavaMetaClassOper
```
protected final OutTextPreparer sJavaMetaClassOper
```
  - tJavaMetaClassZbnf
```
protected final OutTextPreparer tJavaMetaClassZbnf
```
- Constructor Detail
  - GenJavaOutClass
```
public GenJavaOutClass(GenJavaOutClass.CmdArgs args,
                       LogMessage log)
```
- Method Detail
  - setupWriter
```
public void setupWriter()
```
  - closeWrite
```
public void closeWrite()
```
  - convertToIdentifier
```
public static java.lang.String convertToIdentifier(java.lang.String src)
```
  - firstUppercaseIdentifier
```
public static java.lang.String firstUppercaseIdentifier(java.lang.String src)
```
  - firstLowercaseIdentifier
```
public static java.lang.String firstLowercaseIdentifier(java.lang.String src)
```
  - finishCmpnWrite
```
public void finishCmpnWrite()
                     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - finishClassWrite
```
public void finishClassWrite()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException

Class GenJavaOutClass

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

cmdArgs

log

wrz

wru

wr

sJavaOutputDir

superTypes

idxStdTypes

listCmpn

idxRegisteredCmpn

reservedNames

tJavaHeadBase

tJavaHeadUsg

sJavaHeadZbnf

tJavaSuperTypeClass

tJavaCmpnClass_Base

tJavaCmpnClassZbnf

tJavaCmpnClassUsg

tJavaCmpnEnd

tJavaEnd

tJavaSimpleVar

tJavaListVar

tJavaListAllVar

tJavaSimpleVarOper

tJavaListVarOper

tJavaSimpleVarZbnf

tJavaListVarZbnf

tJavaCmpnZbnf

tJavaListCmpnZbnf

sJavaMetaClass

sJavaMetaClassOper

tJavaMetaClassZbnf

Constructor Detail

GenJavaOutClass

Method Detail

setupWriter

closeWrite

convertToIdentifier

firstUppercaseIdentifier

firstLowercaseIdentifier

finishCmpnWrite

finishClassWrite