Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.lmslogger
Class LmsEnumGenerator

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.lmslogger.LmsEnumGenerator

public class LmsEnumGenerator
extends java.lang.Object

Platform SDK AppTemplate AB Code generation Tool for LMS enumerations.

It takes given '.lms' file and generates Java source file with AppTemplate specific LMS enumeration.

Usage:
  %> java -cp apptemplate.jar com.genesyslab.platform.apptemplate.lmslogger.LmsEnumGenerator <LMS-filename> <target-enum-name> <target-enum-package> [<out-src-dir>]

Default value for <out-src-dir> is "src/main/java".

For example,
  %> java ...LmsEnumGenerator MyApp.lms MyAppEnum com.genesyslab.myapp src/main/java
takes 'MyApp.lms' and generates correspondent LMS enumeration into 'src/main/java/com/genesyslab/myapp/MyAppEnum.java'.


Field Summary
protected static java.lang.String PATH_SEPARATOR
           
 
Constructor Summary
LmsEnumGenerator()
           
 
Method Summary
protected  java.lang.String getEnumItemJavadocStr(LmsMessageTemplate item)
           
static void main(java.lang.String[] args)
          The Generator utility entry point.
 void printEnum(LmsFileData lms, java.io.PrintStream out, java.lang.String packageName, java.lang.String enumName)
          Generates full java source text of target enumeration including copyright header.
protected  void printEnumFileFooter(java.io.PrintStream out, java.lang.String enumName)
           
protected  void printEnumFileHeader(java.io.PrintStream out, java.lang.String packageName, java.lang.String enumName, LmsFileData lms)
           
protected  void printEnumFileLmsHeader(java.io.PrintStream out, java.lang.String packageName, java.lang.String enumName, LmsFileData lms)
           
protected  void printEnumItems(java.io.PrintStream out, LmsFileData lms, java.lang.String enumName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PATH_SEPARATOR

protected static final java.lang.String PATH_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

LmsEnumGenerator

public LmsEnumGenerator()
Method Detail

main

public static void main(java.lang.String[] args)
                 throws LmsLoadException,
                        java.io.FileNotFoundException,
                        java.lang.IllegalArgumentException
The Generator utility entry point.

Parameters:
args - command line arguments.
Throws:
LmsLoadException - in cases of LMS file load exception.
java.lang.IllegalArgumentException - if output directory does not exist.
java.io.FileNotFoundException - if failed to create the output file.

printEnum

public void printEnum(LmsFileData lms,
                      java.io.PrintStream out,
                      java.lang.String packageName,
                      java.lang.String enumName)
Generates full java source text of target enumeration including copyright header.

Parameters:
lms - loaded Messages file data.
out - output stream to print full content of resulting java text.
packageName - java package of target enumeration.
enumName - class name of target enumeration.

printEnumFileHeader

protected void printEnumFileHeader(java.io.PrintStream out,
                                   java.lang.String packageName,
                                   java.lang.String enumName,
                                   LmsFileData lms)

printEnumFileLmsHeader

protected void printEnumFileLmsHeader(java.io.PrintStream out,
                                      java.lang.String packageName,
                                      java.lang.String enumName,
                                      LmsFileData lms)

printEnumFileFooter

protected void printEnumFileFooter(java.io.PrintStream out,
                                   java.lang.String enumName)

printEnumItems

protected void printEnumItems(java.io.PrintStream out,
                              LmsFileData lms,
                              java.lang.String enumName)

getEnumItemJavadocStr

protected java.lang.String getEnumItemJavadocStr(LmsMessageTemplate item)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.