de.viaboxx.nlstools.formats

Class BundleWriterJavaInterface

java.lang.Object

de.viaboxx.nlstools.formats.BundleWriter

de.viaboxx.nlstools.formats.BundleWriterJavaInterface

Direct Known Subclasses:

BundleWriterGroovyEnum, BundleWriterTypeScript

public class BundleWriterJavaInterface
extends BundleWriter

Description:
User: roman.stumm
Date: 15.06.2007
Time: 12:14:13
License: Apache 2.0

Nested Class Summary

Nested classes/interfaces inherited from class de.viaboxx.nlstools.formats.BundleWriter

BundleWriter.FileType

Field Summary

Fields

Modifier and Type	Field and Description
protected int	indentNum
protected int	indentSize

Fields inherited from class de.viaboxx.nlstools.formats.BundleWriter

allowedLocales, bundles, configFile, currentBundle, debugMode, deleteOldFiles, fileType, flexLayout, myUsedLocales, outputPath, overwrite, task

Constructor Summary

Constructors

Constructor and Description
BundleWriterJavaInterface(org.apache.tools.ant.Task task, String configFile, MBBundle currentBundle, String outputPath, BundleWriter.FileType fileType, Set<String> allowedLocales)

Method Summary

Modifier and Type	Method and Description
protected String	createKeyName(String keyName)
String	getExampleLocale()
protected String	getIClass()
protected String	getInterfaceFileName()
protected String	getInterfacePathName()
protected boolean	isKeyNotContained()
protected boolean	isKeysContained()
protected boolean	needsNewFiles() true when generation is neccessary, false when up-to-date
protected void	printEntryComment(PrintWriter pw, MBEntry eachEntry, Iterator<MBText> texts)
protected PrintWriter	printIndent(PrintWriter pw)
void	setExampleLocale(String exampleLocale)
protected String	suffix()
protected void	writeConstants(PrintWriter pw, MBBundle aBundle) Write the constants to the interface file.
protected void	writeDoNotAlter(PrintWriter pw)
protected void	writeKeyValue(PrintWriter pw, String key, String value)
void	writeOutputFiles() generate the current bundle's interface
protected void	writeStaticIntro(PrintWriter pw) Write the static beginning of the interface file.
protected void	writeStaticOutro(PrintWriter pw) Write the static end of the interface file.
protected void	writeType(PrintWriter pw)

Methods inherited from class de.viaboxx.nlstools.formats.BundleWriter

buildOutputFileNameBase, buildOutputFileNameBase, createProperties, createProperties, deleteFiles, deleteFiles, execute, getCurrentBundle, getFileName, getFileNameFlex, getFileNameJava, getLocalesUsed, getLocalesUsed, getOutputPath, getOutputPathName, isFlexLayout, mkdirs, setBundles, setDebugMode, setDeleteOldFiles, setFlexLayout, setOverwrite, writeOutputFilePerLocale

Methods inherited from class java.lang.Object

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

Field Detail

indentNum

protected int indentNum

indentSize

protected int indentSize

Constructor Detail

BundleWriterJavaInterface

public BundleWriterJavaInterface(org.apache.tools.ant.Task task,
                                 String configFile,
                                 MBBundle currentBundle,
                                 String outputPath,
                                 BundleWriter.FileType fileType,
                                 Set<String> allowedLocales)

Method Detail

getExampleLocale

public String getExampleLocale()

setExampleLocale

public void setExampleLocale(String exampleLocale)

suffix

protected String suffix()

Specified by:

suffix in class BundleWriter

writeOutputFiles

public void writeOutputFiles()
                      throws Exception

generate the current bundle's interface

Overrides:

writeOutputFiles in class BundleWriter

Throws:

Exception

isKeysContained

protected boolean isKeysContained()

isKeyNotContained

protected boolean isKeyNotContained()

getIClass

protected String getIClass()

getInterfaceFileName

protected String getInterfaceFileName()

getInterfacePathName

protected String getInterfacePathName()

writeStaticIntro

protected void writeStaticIntro(PrintWriter pw)

Write the static beginning of the interface file.

Parameters:

pw - writer to write to

writeType

protected void writeType(PrintWriter pw)

writeDoNotAlter

protected void writeDoNotAlter(PrintWriter pw)

writeStaticOutro

protected void writeStaticOutro(PrintWriter pw)

Write the static end of the interface file.

Parameters:

pw - writer to write to

writeConstants

protected void writeConstants(PrintWriter pw,
                              MBBundle aBundle)

Write the constants to the interface file.

Parameters:

pw - writer to write to

aBundle - to read from

printEntryComment

protected void printEntryComment(PrintWriter pw,
                                 MBEntry eachEntry,
                                 Iterator<MBText> texts)

writeKeyValue

protected void writeKeyValue(PrintWriter pw,
                             String key,
                             String value)

createKeyName

protected String createKeyName(String keyName)

needsNewFiles

protected boolean needsNewFiles()
                         throws FileNotFoundException

true when generation is neccessary, false when up-to-date

Overrides:

needsNewFiles in class BundleWriter

Throws:

FileNotFoundException

printIndent

protected PrintWriter printIndent(PrintWriter pw)