KEYSFileGenerator (SAFS API DOCUMENT)

java.lang.Object
- org.safs.text.KEYSFileGenerator

```
public class KEYSFileGenerator
extends java.lang.Object
```
To generate FAILKEYS, GENKEYS java file from .properties files.
PLEASE use English properties file, as the property value will be used as comment.
For other properties file, the value will be encoded in UNICODE and it is not readable for human.
java org.safs.text.KEYSFileGenerator [args]

args:

-properties <pathTo>/resource.properties

REQUIRED absolute path to the properties file to process.

Examples:

-out OutputDirectory

REQUIRED path to the directory in which to write the new Java Class file.

Example:

-out "D:\workspace\RftDevJ\"

-name classname

OPTIONAL Alternate name to give the generated java class. When not specified, the resource-bundle-name will be used. There are exceptions for historical reason, if the resource-bundle-name is "failedSAFSTextResourceBundle", the class name is "FAILKEYS"; and if resource-bundle-name is "SAFSTextResourceBundle", the class name is "GENKEYS".

Example:

-package JavaPackageName

OPTIONAL package name to use for the output Java Class file. When not specified, no package name is written. The class is part of the nameless (default) Java package.

Example:

-package "org.safs.text"

Putting it all together for some sample invocations:

  java org.safs.text.KEYSFileGenerator -properties D:\workspace\RftDevJ\org\safs\SAFSTextResourceBundle_en_US.properties -out D:\workspace\RftDevJ\
  java org.safs.text.KEYSFileGenerator -properties D:\workspace\RftDevJ\org\safs\SAFSTextResourceBundle_en_US.properties -out D:\workspace\RftDevJ\ -package org.safs.text
  java org.safs.text.KEYSFileGenerator -properties D:\workspace\RftDevJ\org\safs\SAFSTextResourceBundle_en_US.properties -out D:\workspace\RftDevJ\ -package org.safs.text -name SAFSTextResourceBundle
  java org.safs.text.KEYSFileGenerator -properties D:\workspace\RftDevJ\org\safs\failedSAFSTextResourceBundle_en_US.properties -out D:\workspace\RftDevJ\ -package org.safs.text -name failedSAFSTextResourceBundle

It is possible that we call this class without any parameter, it will generate java key class for 2 .properties files (failedSAFSTextResourceBundle_en_US.properties and SAFSTextResourceBundle_en_US.properties under package org.safs), the 2 generated java files will be org.safs.text.FAILKEYS and org.safs.text.GENKEYS

java org.safs.text.KEYSFileGenerator

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TAB_NUMBER` the number of tabs from the beginning of a line before the equal sign, here we give 18.
`static java.lang.String`	`paramName`
`static java.lang.String`	`paramOut`
`static java.lang.String`	`paramPackage`
`static java.lang.String`	`paramPropertyFile`
`static int`	`TAB_LENGTH` the number of space that a Tabulation represents, it is normally 4 in java source code.
`static java.lang.String`	`usage`

Constructor Summary

Constructors
Constructor and Description

KEYSFileGenerator()

Constructors
Constructor and Description
`KEYSFileGenerator()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void main(java.lang.String[] args)
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(java.lang.String[] args)`

- Field Detail
  - paramPropertyFile
```
public static final java.lang.String paramPropertyFile
```
    See Also:
    
    Constant Field Values
  - paramOut
```
public static final java.lang.String paramOut
```
    See Also:
    
    Constant Field Values
  - paramName
```
public static final java.lang.String paramName
```
    See Also:
    
    Constant Field Values
  - paramPackage
```
public static final java.lang.String paramPackage
```
    See Also:
    
    Constant Field Values
  - usage
```
public static final java.lang.String usage
```
    See Also:
    
    Constant Field Values
  - TAB_LENGTH
```
public static final int TAB_LENGTH
```
    the number of space that a Tabulation represents, it is normally 4 in java source code.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TAB_NUMBER
```
public static final int DEFAULT_TAB_NUMBER
```
    the number of tabs from the beginning of a line before the equal sign, here we give 18. If some property has longer name, we may adjust this value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - KEYSFileGenerator
```
public KEYSFileGenerator()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```

Class KEYSFileGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

paramPropertyFile

paramOut

paramName

paramPackage

usage

TAB_LENGTH

DEFAULT_TAB_NUMBER

Constructor Detail

KEYSFileGenerator

Method Detail

main