Package org.apache.maven.api.cli.mvnenc

Interface EncryptOptions

All Superinterfaces:

Options

All Known Implementing Classes:

CommonsCliEncryptOptions

@Experimental
public interface EncryptOptions
extends Options

Defines the options specific to the Maven encryption tool. This interface extends the general Options interface, adding encryption-specific configuration options.

Since:

4.0.0

Field Summary

Fields inherited from interface org.apache.maven.api.cli.Options

SOURCE_CLI

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	force()	Should the operation be forced (ie overwrite existing config, if any).
Optional<List<String>>	goals()	Returns the list of encryption goals to be executed.
EncryptOptions	interpolate(Collection<Map<String,String>> properties)	Returns a new instance of EncryptOptions with values interpolated using the given properties.
Optional<Boolean>	yes()	Should imply "yes" to all questions.

Methods inherited from interface org.apache.maven.api.cli.Options

altInstallationSettings, altInstallationToolchains, altProjectSettings, altUserSettings, altUserToolchains, color, displayHelp, failOnSeverity, forceInteractive, help, logFile, nonInteractive, quiet, rawStreams, showErrors, showVersion, showVersionAndExit, source, userProperties, verbose, warnAboutDeprecatedOptions

Method Details

force

Optional<Boolean> force()

Should the operation be forced (ie overwrite existing config, if any).

Returns:

an Optional containing the boolean value true if specified, or empty

yes

Optional<Boolean> yes()

Should imply "yes" to all questions.

Returns:

an Optional containing the boolean value true if specified, or empty

goals

@Nonnull
Optional<List<String>> goals()

Returns the list of encryption goals to be executed. These goals can include operations like "init", "add-server", "delete-server", etc.

Returns:

an Optional containing the list of goals, or empty if not specified

interpolate

@Nonnull
EncryptOptions interpolate(Collection<Map<String,String>> properties)

Returns a new instance of EncryptOptions with values interpolated using the given properties.

Specified by:

interpolate in interface Options

Parameters:

properties - a collection of property maps to use for interpolation

Returns:

a new EncryptOptions instance with interpolated values