Author: tfmorris Date: 2008-05-07 09:45:06-0700 New Revision: 14654 Modified: trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java
Log: Add TODO for code generation settings Modified: trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java?view=diff&rev=14654&p1=trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java&p2=trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java&r1=14653&r2=14654 ============================================================================== --- trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java (original) +++ trunk/src/argouml-app/src/org/argouml/uml/generator/CodeGenerator.java 2008-05-07 09:45:06-0700 @@ -27,20 +27,24 @@ import java.util.Collection; /** - * Defines the methods to generate source code from the model. - * Each class providing code generation functionality should implement - * this. - * Replaces the FileGenerator interface. + * Defines the methods to generate source code from the model. Each class + * providing code generation functionality must implement this to be recognized + * by ArgoUML as a code generator. + * <p> + * TODO: A GUI-independent mechanism to pass settings to the code generator is + * needed similar to what we have for reverse engineering. See + * [EMAIL PROTECTED] org.argouml.uml.reveng.ImportInterface#getImportSettings()} and + * [EMAIL PROTECTED] org.argouml.uml.reveng.SettingsTypes} + * + * @since 0.20 when it replaced the FileGenerator interface. */ public interface CodeGenerator { + /** - * The file seperator for this operating system. + * The file separator for this operating system. */ String FILE_SEPARATOR = System.getProperty("file.separator"); - // FIXME: maybe convert all Collections of modelelements - // into Sets, because they shall not contain duplicate elements. - /** * Generate code for the specified classifiers. If generation of * dependencies is requested, then every file the specified elements @@ -56,12 +60,13 @@ /** * Generate files for the specified classifiers. + * * @see #generate(Collection, boolean) * @param elements the UML model elements to generate code for. * @param path The source base path. * @param deps Recursively generate dependency files too. * @return The filenames (with relative path) as a collection of Strings. - * The collection may be empty if no file will be generated. + * The collection may be empty if no file will be generated. */ Collection<String> generateFiles(Collection elements, String path, boolean deps); @@ -69,11 +74,12 @@ /** * Returns a list of files that will be generated from the specified * modelelements. + * * @see #generate(Collection, boolean) * @param elements the UML model elements to generate code for. * @param deps Recursively generate dependency files too. * @return The filenames (with relative path) as a collection of Strings. - * The collection may be empty if no file will be generated. + * The collection may be empty if no file will be generated. */ Collection<String> generateFileList(Collection elements, boolean deps); } --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
