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

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="probe",
      defaultPhase=PROCESS_SOURCES,
      threadSafe=true)
public final class ProbeMojo
extends org.apache.maven.plugin.AbstractMojo
```
Go through all `probe` metas in XMIR files, try to locate the objects pointed by `probe` in Objectionary and if found register them in catalog. More about the purpose of this Mojo is in this issue.

Since:

0.28.11

Field Summary

Fields
Modifier and Type	Field	Description
`protected File`	`foreign`	File with foreign "tojos".
`protected String`	`foreignFormat`	Format of "foreign" file ("json" or "csv").
`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 org.cactoos.scalar.Unchecked<com.yegor256.tojos.Tojos>`	`placedTojos`	Cached 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 org.cactoos.scalar.Unchecked<com.yegor256.tojos.Tojos>`	`tojos`	Cached tojos.
`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.

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

Constructor Summary

Constructors
Constructor Description

ProbeMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`exec()`
`void`	`execute()`
`protected com.yegor256.tojos.Tojos`	`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

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="csv")
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

tojos

protected final org.cactoos.scalar.Unchecked<com.yegor256.tojos.Tojos> tojos

Cached tojos.

placedTojos

protected final org.cactoos.scalar.Unchecked<com.yegor256.tojos.Tojos> placedTojos

Cached placed tojos.

transpiledTojos

protected final TranspiledTojos transpiledTojos

Cached transpiled tojos.

Constructor Detail
- ProbeMojo
```
public ProbeMojo()
```

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

Throws:: org.apache.maven.plugin.MojoFailureException; org.apache.maven.plugin.MojoExecutionException

scopedTojos
```
protected final com.yegor256.tojos.Tojos scopedTojos()
```
Tojos to use, in my scope only.

Returns:

Tojos to use

Class ProbeMojo