ReadMavenPomStep (Pipeline Utility Steps 2.18.0 API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
- - org.jenkinsci.plugins.workflow.steps.Step
  - - org.jenkinsci.plugins.pipeline.utility.steps.maven.ReadMavenPomStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>
```
public class ReadMavenPomStep
extends org.jenkinsci.plugins.workflow.steps.Step
```
Reads a maven pom file from the workspace.

Author:

Robert Sandell <rsandell@cloudbees.com>.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ReadMavenPomStep.DescriptorImpl`
`static class`	`ReadMavenPomStep.Execution`
`static class`	`ReadMavenPomStep.PackageAutoImporter`	Auto imports org.apache.maven.model.* .
`static class`	`ReadMavenPomStep.WhiteLister`	Whitelists all non static setters, getters and constructors in the package org.apache.maven.model.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors
Constructor Description

ReadMavenPomStep()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getFile()`	Optional name of the maven file to read.
`void`	`setFile(String file)`	Optional name of the maven file to read.
`org.jenkinsci.plugins.workflow.steps.StepExecution`	`start(org.jenkinsci.plugins.workflow.steps.StepContext context)`

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step
getDescriptor

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

- Constructor Detail
  - ReadMavenPomStep
```
@DataBoundConstructor
public ReadMavenPomStep()
```
- Method Detail
  - start
```
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception
```
    Specified by:
    
    start in class org.jenkinsci.plugins.workflow.steps.Step
    
    Throws:
    
    Exception
  - getFile
```
public String getFile()
```
    Optional name of the maven file to read. If empty 'pom.xml' in the current working directory will be used.
    
    Returns:
    
    file name
  - setFile
```
@DataBoundSetter
public void setFile(String file)
```
    Optional name of the maven file to read. If empty 'pom.xml' in the current working directory will be used.
    
    Parameters:
    
    file - optional file name