com.nomagic.magicdraw.commandline

Class CommandLine

java.lang.Object

com.nomagic.magicdraw.commandline.CommandLine

All Implemented Interfaces:

com.nomagic.magicdraw.core.ApplicationLauncher

@OpenApiAll
public abstract class CommandLine
extends java.lang.Object
implements com.nomagic.magicdraw.core.ApplicationLauncher

MagicDraw commandline launcher.
Extend it and implement run() method.

Code sample:

public class TestCommandLine extends CommandLine
 {
        public static void main(String[] args)
     {
                new TestCommandLine().launch(args);
     }

        protected void run()
     {
                // load project
                File fileToLoad = new File("myProject.mdzip");
                ProjectDescriptor descriptor = ProjectDescriptorsFactory.createProjectDescriptor(fileToLoad.toURI());
                ProjectsManager projectsManager = Application.getInstance().getProjectsManager();
                projectsManager.loadProject(descriptor, true);

                Project project = Application.getInstance().getProject();

                // "save as" project
                File fileToSave = new File("myProject2.mdzip");
                ProjectDescriptor localProjectDescriptor = ProjectDescriptorsFactory.createLocalProjectDescriptor(project, fileToSave);
                projectsManager.saveProject(localProjectDescriptor, true);
     }
 }

Startup sample:
java -cp <MagicDraw libraries> -Dinstall.root=<MagicDraw installation directory> -Xmx300M -Xss16M TestCommandLine

<MagicDraw libraries> - all jar's (except md_commontw.jar and md_commontw_api.jar) recursively from <MagicDraw installation directory>/lib

Constructor Summary

Constructors

Constructor and Description
CommandLine()

Method Summary

Methods

Modifier and Type	Method and Description
protected byte	execute() Override this method to execute your custom task(s) in running MagicDraw environment.
void	launch(java.lang.String[] args) Launch MagicDraw in commandline mode (without GUI). Method starts MagicDraw application, calls run() method, and shuts down the application.
protected void	parseArgs(java.lang.String[] args) Override to parse arguments before launching MagicDraw.
protected void	run() Deprecated. see execute() method.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandLine

public CommandLine()

Method Detail

launch

public final void launch(java.lang.String[] args)

Launch MagicDraw in commandline mode (without GUI).
Method starts MagicDraw application, calls run() method, and shuts down the application.

Specified by:

launch in interface com.nomagic.magicdraw.core.ApplicationLauncher

Parameters:

args - command line arguments passed to MagicDraw.

parseArgs

protected void parseArgs(java.lang.String[] args)
                  throws java.lang.Exception

Override to parse arguments before launching MagicDraw.

Parameters:

args - program arguments

Throws:

java.lang.Exception - if arguments are not correct and MagicDraw should not be started

run

@Deprecated
protected void run()

Deprecated. see execute() method.

See Also:

execute()

execute

protected byte execute()

Override this method to execute your custom task(s) in running MagicDraw environment. Do not explicitly call this method - call launch(String[]) to launch the commandline. Default implementation calls run() to ensure compatibility with older versions.

Returns:

application exit status (default is 0).