java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.eolang.maven.SodgMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="sodg",
      defaultPhase=PROCESS_SOURCES,
      threadSafe=true,
      requiresDependencyResolution=COMPILE)
public final class SodgMojo
extends org.apache.maven.plugin.AbstractMojo
```
Convert XMIR to SODG. SODG (Surging Object DiGraph) is our own format of graph representation. It essentially is a text file that consists of instructions for a virtual machine that is capable of parsing them and building a graph. An example of such a machine can be found in this repository. When the graph is built by the virtual machine, it must be possible to execute a program using graph traversing algorithm. An example of such an executor of a graph can be found in this repository.

Since:

0.27

Field Summary

Fields
Modifier and Type	Field	Description
`protected Path`	`cache`	EO cache directory.
`static String`	`DIR`	The directory where to save SODG to.
`protected File`	`foreign`	File with foreign "tojos".
`protected String`	`foreignFormat`	Format of "foreign" file ("json" or "csv").
`protected Map<String,? extends CommitHash>`	`hashes`	Commit hashes.
`protected org.apache.maven.plugin.BuildPluginManager`	`manager`	Maven plugin manager.
`protected File`	`placed`	The path to a text file where paths of all added .class (and maybe others) files are placed.
`protected String`	`placedFormat`	Format of "placed" file ("json" or "csv").
`protected PlacedTojos`	`placedTojos`	Placed tojos.
`protected org.apache.maven.project.MavenProject`	`project`	Maven project.
`protected String`	`scope`	Current scope (either "compile" or "test").
`protected org.apache.maven.execution.MavenSession`	`session`	Maven session.
`protected File`	`targetDir`	Target directory.
`protected Integer`	`timeout`	Mojo execution timeout in seconds.
`protected File`	`transpiled`	The path to a text file where paths of generated java files per EO program.
`protected String`	`transpiledFormat`	Format of "transpiled" file ("json" or "csv").
`protected TranspiledTojos`	`transpiledTojos`	Cached transpiled tojos.
`protected boolean`	`unrollExitError`	If set to TRUE, the exception on exit will be printed in details to the log.
`protected boolean`	`withVersions`	Used for object versioning implementation.

Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE

Constructor Summary

Constructors
Constructor Description

SodgMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`exec()`
`void`	`execute()`	Execute it.
`protected ForeignTojos`	`scopedTojos()`	Tojos to use, in my scope only.

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIR
```
public static final String DIR
```
The directory where to save SODG to.

See Also:

Constant Field Values

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

Maven project.

session

@Parameter(defaultValue="${session}",
           readonly=true)
protected org.apache.maven.execution.MavenSession session

Maven session.

manager

@Component
protected org.apache.maven.plugin.BuildPluginManager manager

Maven plugin manager.

foreign

@Parameter(property="eo.foreign",
           required=true,
           defaultValue="${project.build.directory}/eo-foreign.csv")
protected File foreign

File with foreign "tojos".

foreignFormat

@Parameter(property="eo.foreignFormat",
           required=true,
           defaultValue="csv")
protected String foreignFormat

Format of "foreign" file ("json" or "csv").

targetDir

@Parameter(property="eo.targetDir",
           required=true,
           defaultValue="${project.build.directory}/eo")
protected File targetDir

Target directory.

scope

@Parameter(property="eo.scope")
protected String scope

Current scope (either "compile" or "test").

placed

@Parameter(property="eo.placed",
           required=true,
           defaultValue="${project.build.directory}/eo-placed.csv")
protected File placed

The path to a text file where paths of all added .class (and maybe others) files are placed.

Since:: 0.11.0

placedFormat

@Parameter(property="eo.placedFormat",
           required=true,
           defaultValue="json")
protected String placedFormat

Format of "placed" file ("json" or "csv").

transpiled

@Parameter(property="eo.transpiled",
           required=true,
           defaultValue="${project.build.directory}/eo-transpiled.csv")
protected File transpiled

The path to a text file where paths of generated java files per EO program.

Since:: 0.11.0

timeout

@Parameter(property="eo.timeout")
protected Integer timeout

Mojo execution timeout in seconds.

Since:: 0.28.12

transpiledFormat

@Parameter(property="eo.transpiledFormat",
           required=true,
           defaultValue="csv")
protected String transpiledFormat

Format of "transpiled" file ("json" or "csv").

unrollExitError
```
@Parameter(property="eo.unrollExitError")
protected boolean unrollExitError
```
If set to TRUE, the exception on exit will be printed in details to the log.

Since:

0.29.0

cache

@Parameter(property="eo.cache")
protected Path cache

EO cache directory.

withVersions
```
@Parameter(property="eo.withVersions",
           defaultValue="false")
protected boolean withVersions
```
Used for object versioning implementation. If set to TRUE - objects are parsed, stored in tojos and processed as versioned.

hashes

protected final Map<String,? extends CommitHash> hashes

Commit hashes.

placedTojos

protected final PlacedTojos placedTojos

Placed tojos.

transpiledTojos

protected final TranspiledTojos transpiledTojos

Cached transpiled tojos.

Constructor Detail
- SodgMojo
```
public SodgMojo()
```

Method Detail

exec

public void exec()
          throws IOException

Throws:: IOException

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoFailureException,
                          org.apache.maven.plugin.MojoExecutionException

Execute it.

Throws:: org.apache.maven.plugin.MojoFailureException - If fails during build; org.apache.maven.plugin.MojoExecutionException - If fails during execution

scopedTojos
```
protected final ForeignTojos scopedTojos()
```
Tojos to use, in my scope only.

Returns:

Tojos to use

Class SodgMojo