Package org.eigenbase.resgen
Class AbstractGenerator
java.lang.Object
org.eigenbase.resgen.AbstractGenerator
- All Implemented Interfaces:
Generator
- Direct Known Subclasses:
AbstractJavaGenerator
,CppGenerator
Abstract base for all generators.
- Since:
- 19 September, 2005
- Version:
- $Id: //open/util/resgen/src/org/eigenbase/resgen/AbstractGenerator.java#3 $
- Author:
- jhyde
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
protected void
protected abstract void
generateResource
(ResourceDef.Resource resource, PrintWriter pw) Generates code for a particular resource.protected abstract String[]
getArgTypes
(String message) Returns the number and types of parameters in the given error message, expressed as an array of Strings (legal values are currently "String", "Number", "java.util.Date", and null) ordered by parameter number.protected String
getArgumentList
(String message) protected abstract String
Returns the fully-qualified name of the base class.protected abstract String
Returns the fully-qualified name of the class being generated, for example "happy.BirthdayResource_en_US".protected File
getFile()
Returns the generator's output file.protected String
getParameterList
(String message) Returns a parameter list string, e.g.protected String
Returns the XML or .properties source file, in a manner suitable for use in source code comments.void
setScmSafeComments
(boolean enabled) Configures whether this generator will output comments that may be submitted to a source code management system.protected boolean
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eigenbase.resgen.Generator
generateModule
-
Constructor Details
-
AbstractGenerator
-
-
Method Details
-
setScmSafeComments
public void setScmSafeComments(boolean enabled) Description copied from interface:Generator
Configures whether this generator will output comments that may be submitted to a source code management system. In general, it squelches comments indicating the file should not be checked in as well as comments change with each generation of the file (thereby avoiding merge conflicts).- Specified by:
setScmSafeComments
in interfaceGenerator
- Parameters:
enabled
-
-
useScmSafeComments
protected boolean useScmSafeComments() -
generateResource
Generates code for a particular resource. -
generateDoNotModifyHeader
-
generateGeneratedByBlock
-
getFile
Returns the generator's output file. e.g., "BirthdayResource.java" -
getSrcFileForComment
Returns the XML or .properties source file, in a manner suitable for use in source code comments. Path information is stripped if SCM-safe comment style is enabled.- See Also:
-
getClassName
Returns the fully-qualified name of the class being generated, for example "happy.BirthdayResource_en_US". -
getBaseClassName
Returns the fully-qualified name of the base class. -
getParameterList
Returns a parameter list string, e.g. "String p0, int p1". -
getArgTypes
Returns the number and types of parameters in the given error message, expressed as an array of Strings (legal values are currently "String", "Number", "java.util.Date", and null) ordered by parameter number. -
getArgumentList
-