ScmTagParameters (Maven SCM 2.2.1 API)

java.lang.Object
- org.apache.maven.scm.ScmTagParameters

All Implemented Interfaces:

Serializable
```
public class ScmTagParameters
extends Object
implements Serializable
```
Since:

1.2

Author:

Olivier Lamy

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

ScmTagParameters()

ScmTagParameters(String message)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getMessage()`
`String`	`getScmRevision()`
`CommandParameters.SignOption`	`getSignOption()`	Get the signing option for the tag operation.
`boolean`	`isPinExternals()`
`boolean`	`isRemoteTagging()`
`boolean`	`isSign()`	Deprecated. use `getSignOption()` instead
`void`	`setMessage(String message)`
`void`	`setPinExternals(boolean pinExternals)`
`void`	`setRemoteTagging(boolean remoteTagging)`
`void`	`setScmRevision(String scmRevision)`
`void`	`setSign(boolean sign)`	Deprecated. use `setSignOption(org.apache.maven.scm.CommandParameters.SignOption)` instead
`void`	`setSignOption(CommandParameters.SignOption signOption)`	Set the signing option for the tag operation.
`String`	`toString()`

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

Constructor Detail

ScmTagParameters
```
public ScmTagParameters()
```

ScmTagParameters

public ScmTagParameters(String message)

Method Detail

getMessage
```
public String getMessage()
```

setMessage

public void setMessage(String message)

isRemoteTagging
```
public boolean isRemoteTagging()
```

setRemoteTagging

public void setRemoteTagging(boolean remoteTagging)

isPinExternals
```
public boolean isPinExternals()
```

setPinExternals

public void setPinExternals(boolean pinExternals)

isSign
```
@Deprecated
public boolean isSign()
```
Deprecated.
use getSignOption() instead

Returns:

true if the tag operation should be signed, false otherwise

setSign
```
@Deprecated
public void setSign(boolean sign)
```
Deprecated.
use setSignOption(org.apache.maven.scm.CommandParameters.SignOption) instead

Set the signing option for the tag operation.

Parameters:

sign -

getScmRevision
```
public String getScmRevision()
```

setScmRevision

public void setScmRevision(String scmRevision)

getSignOption
```
public CommandParameters.SignOption getSignOption()
```
Get the signing option for the tag operation.

Returns:

the signing option

Since:

2.2.1

setSignOption
```
public void setSignOption(CommandParameters.SignOption signOption)
```
Set the signing option for the tag operation.

Parameters:

signOption -

Since:

2.2.1

toString
```
public String toString()
```
Overrides:

toString in class Object