com.vp.plugin

Interface CodeSyncManager

public interface CodeSyncManager

Round-trip code model synchronization relate functions. A set of functions for perform round-trip code engineering (Java & C++) for Visual Paradigm which integrated with various IDEs. Methods are not applicable to standalone Visual Paradigm client.

Method Summary

Modifier and Type	Method and Description
void	forceUpdateToCode() Perform full code generation for all models in the project no matter the model is modified or not.
void	forceUpdateToCode(java.awt.Component invoker) Perform full code generation for all models in the project no matter the model is modified or not.
void	forceUpdateToCode(java.awt.Component invoker, IModelElement[] models) Perform full code generation for specified models in the project no matter they are modified or not.
void	forceUpdateToCode(IModelElement[] models) Perform full code generation for specified models in the project no matter they are modified or not.
void	forceUpdateToUML() Perform full code reverse engineering for all source files under the source path configured to the project no matter the source file is modified or not.
void	forceUpdateToUML(java.awt.Component invoker) Perform full code reverse engineering for all source files under the source path configured to the project, no matter the source file is modified or not.
java.io.File	getProjectFolder() Retrieve the folder in file system which containing the project file.
java.io.File[]	getProjectSourceFolders() Retrieve the source folders configured to project.
boolean	isCodeSyncSupported() Check is round-trip code engineering supported by current running edition of Visual Paradigm.
void	updateToCode() Perform code generation for the entire project.
void	updateToCode(java.awt.Component invoker) Perform code generation for modified models in the project.
void	updateToCode(java.awt.Component invoker, IModelElement[] models) Perform code generation on selected model elements in project.
void	updateToCode(IModelElement[] models) Perform code generation on selected model elements in project.
void	updateToUML() Perform code reverse engineering to the modified source files.
void	updateToUML(java.awt.Component invoker) Perform code reverse engineering to the modified source folder.

Method Detail

isCodeSyncSupported

boolean isCodeSyncSupported()

Check is round-trip code engineering supported by current running edition of Visual Paradigm.

Returns:

updateToCode

void updateToCode()

Perform code generation for the entire project. If message dialog being shown during code generation process the main application window will become the invoker of the dialog.

updateToCode

void updateToCode(java.awt.Component invoker)

Perform code generation for modified models in the project. If message dialog being shown during code generation process the user specified component will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

updateToCode

void updateToCode(IModelElement[] models)

Perform code generation on selected model elements in project. If message dialog being shown during code generation process the main application window will become the invoker of the dialog.

Parameters:

models - - the model elements which will generate source code.

updateToCode

void updateToCode(java.awt.Component invoker,
                  IModelElement[] models)

Perform code generation on selected model elements in project. If message dialog being shown during code generation process the user specified component will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

models - - the model elements which will generate source code.

updateToUML

void updateToUML()

Perform code reverse engineering to the modified source files. If message dialog being show during the code reverse engineering process the main application window will become the invoker of the dialog.

updateToUML

void updateToUML(java.awt.Component invoker)

Perform code reverse engineering to the modified source folder. If message dialog being show during the code reverse engineering process the user specified component window will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

forceUpdateToCode

void forceUpdateToCode()

Perform full code generation for all models in the project no matter the model is modified or not. If message dialog being shown during code generation process the main application window will become the invoker of the dialog.

forceUpdateToCode

void forceUpdateToCode(java.awt.Component invoker)

Perform full code generation for all models in the project no matter the model is modified or not. If message dialog being shown during code generation process the user specified component will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

forceUpdateToCode

void forceUpdateToCode(IModelElement[] models)

Perform full code generation for specified models in the project no matter they are modified or not. If message dialog being shown during code generation process the main application window will become the invoker of the dialog.

Parameters:

models - - the model elements which will generate source code.

forceUpdateToCode

void forceUpdateToCode(java.awt.Component invoker,
                       IModelElement[] models)

Perform full code generation for specified models in the project no matter they are modified or not. If message dialog being shown during code generation process the user specified component will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

models - - the model elements which will generate source code.

forceUpdateToUML

void forceUpdateToUML()

Perform full code reverse engineering for all source files under the source path configured to the project no matter the source file is modified or not. If message dialog being show during the reverse engineering process the main application will become the invoker of the dialog.

forceUpdateToUML

void forceUpdateToUML(java.awt.Component invoker)

Perform full code reverse engineering for all source files under the source path configured to the project, no matter the source file is modified or not. If message dialog being show during the reverse engineering process the user specified invoker component will become the invoker of the dialog.

Parameters:

invoker - - the UI component for invoke the message dialog.

getProjectFolder

java.io.File getProjectFolder()

Retrieve the folder in file system which containing the project file.

Returns:

the folder containing project file.

getProjectSourceFolders

java.io.File[] getProjectSourceFolders()

Retrieve the source folders configured to project. In Java & C++ round-trip engineering user can configure different model container associate to different folder for code generation.

Returns:

array of source folders configured to the project.