MavenMetaDataSelection (buildmetadata-maven-plugin 1.3.0 API)

java.lang.Object
- com.redhat.rcm.maven.plugin.buildmetadata.data.MavenMetaDataSelection

```
public final class MavenMetaDataSelection
extends Object
```
Defines the Maven information to be included in the build meta data.

Version:

$Revision:591 $

Author:

Robert Reiner

Constructor Summary

Constructors
Constructor and Description

MavenMetaDataSelection()

Constructors
Constructor and Description
`MavenMetaDataSelection()`

Method Summary

Methods
Modifier and Type	Method and Description
`List<Property>`	`getSelectedSystemProperties()` Returns the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
`boolean`	`isAddEnvInfo()` Returns the value for addEnvInfo.
`boolean`	`isAddJavaRuntimeInfo()` Returns the value for addJavaRuntimeInfo.
`boolean`	`isAddMavenExecutionInfo()` Returns the value for addMavenExecutionInfo.
`boolean`	`isAddOsInfo()` Returns the value for addOsInfo.
`boolean`	`isAddProjectInfo()` Returns the value for addProjectInfo.
`boolean`	`isHideCommandLineInfo()` Returns the value for hideCommandLineInfo.
`boolean`	`isHideJavaOptsInfo()` Returns the value for hideJavaOptsInfo.
`boolean`	`isHideMavenOptsInfo()` Returns the value for hideMavenOptsInfo.
`void`	`setAddEnvInfo(boolean addEnvInfo)` Sets the value for addEnvInfo.
`void`	`setAddJavaRuntimeInfo(boolean addJavaRuntimeInfo)` Sets the value for addJavaRuntimeInfo.
`void`	`setAddMavenExecutionInfo(boolean addMavenExecutionInfo)` Sets the value for addMavenExecutionInfo.
`void`	`setAddOsInfo(boolean addOsInfo)` Sets the value for addOsInfo.
`void`	`setAddProjectInfo(boolean addProjectInfo)` Sets the value for addProjectInfo.
`void`	`setHideCommandLineInfo(boolean hideCommandLineInfo)` Sets the value for hideCommandLineInfo.
`void`	`setHideJavaOptsInfo(boolean hideJavaOptsInfo)` Sets the value for hideJavaOptsInfo.
`void`	`setHideMavenOptsInfo(boolean hideMavenOptsInfo)` Sets the value for hideMavenOptsInfo.
`void`	`setSelectedSystemProperties(List<Property> selectedSystemProperties)` Sets the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.

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

- Constructor Detail
  - MavenMetaDataSelection
```
public MavenMetaDataSelection()
```
- Method Detail
  - isAddMavenExecutionInfo
```
public boolean isAddMavenExecutionInfo()
```
    Returns the value for addMavenExecutionInfo.
    Add Maven execution information (commandline, goals, profiles, etc. ) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.
    
    Returns:
    the value for addMavenExecutionInfo.
  - setAddMavenExecutionInfo
```
public void setAddMavenExecutionInfo(boolean addMavenExecutionInfo)
```
    Sets the value for addMavenExecutionInfo.
    Add Maven execution information (commandline, goals, profiles, etc. ) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.
    
    Parameters:
    addMavenExecutionInfo - the value for addMavenExecutionInfo.
  - isHideCommandLineInfo
```
public boolean isHideCommandLineInfo()
```
    Returns the value for hideCommandLineInfo.
    While the command line may be useful to refer to for a couple of reasons, displaying it with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    
    Returns:
    the value for hideCommandLineInfo.
  - setHideCommandLineInfo
```
public void setHideCommandLineInfo(boolean hideCommandLineInfo)
```
    Sets the value for hideCommandLineInfo.
    While the command line may be useful to refer to for a couple of reasons, displaying it with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    
    Parameters:
    hideCommandLineInfo - the value for hideCommandLineInfo.
  - isHideMavenOptsInfo
```
public boolean isHideMavenOptsInfo()
```
    Returns the value for hideMavenOptsInfo.
    While the MAVEN_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    
    Returns:
    the value for hideMavenOptsInfo.
  - setHideMavenOptsInfo
```
public void setHideMavenOptsInfo(boolean hideMavenOptsInfo)
```
    Sets the value for hideMavenOptsInfo.
    While the MAVEN_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    
    Parameters:
    hideMavenOptsInfo - the value for hideMavenOptsInfo.
  - isHideJavaOptsInfo
```
public boolean isHideJavaOptsInfo()
```
    Returns the value for hideJavaOptsInfo.
    While the JAVA_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    Therefore the JAVA_OPTS are hidden by default (true). To include this information, use a value of false.
    
    Returns:
    the value for hideJavaOptsInfo.
  - setHideJavaOptsInfo
```
public void setHideJavaOptsInfo(boolean hideJavaOptsInfo)
```
    Sets the value for hideJavaOptsInfo.
    While the JAVA_OPTS may be useful to refer to for a couple of reasons, displaying them with the build properties is a security issue. Some plugins allow to read passwords as properties from the command line and this sensible data will be shown.
    Therefore the JAVA_OPTS are hidden by default (true). To include this information, use a value of false.
    
    Parameters:
    hideJavaOptsInfo - the value for hideJavaOptsInfo.
  - setAddEnvInfo
```
public void setAddEnvInfo(boolean addEnvInfo)
```
    Sets the value for addEnvInfo.
    Add environment variables if set to true, skip it, if set to false. If you are not interested in the environment variables of the host (e.g. for security reasons, set this to false).
    
    Parameters:
    addEnvInfo - the value for addEnvInfo.
  - isAddEnvInfo
```
public boolean isAddEnvInfo()
```
    Returns the value for addEnvInfo.
    Add environment variables if set to true, skip it, if set to false. If you are not interested in the environment variables of the host (e.g. for security reasons, set this to false).
    
    Returns:
    the value for addEnvInfo.
  - isAddJavaRuntimeInfo
```
public boolean isAddJavaRuntimeInfo()
```
    Returns the value for addJavaRuntimeInfo.
    Add information about the Java runtime running the build if set to true, skip it, if set to false.
    
    Returns:
    the value for addJavaRuntimeInfo.
  - setAddJavaRuntimeInfo
```
public void setAddJavaRuntimeInfo(boolean addJavaRuntimeInfo)
```
    Sets the value for addJavaRuntimeInfo.
    Add information about the Java runtime running the build if set to true, skip it, if set to false.
    
    Parameters:
    addJavaRuntimeInfo - the value for addJavaRuntimeInfo.
  - setAddProjectInfo
```
public void setAddProjectInfo(boolean addProjectInfo)
```
    Sets the value for addProjectInfo.
    Add project information (homepage URL, categories, tags, etc.) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.
    
    Parameters:
    addProjectInfo - the value for addProjectInfo.
  - isAddProjectInfo
```
public boolean isAddProjectInfo()
```
    Returns the value for addProjectInfo.
    Add project information (homepage URL, categories, tags, etc.) if set to true, skip it, if set to false. If you are not interested in execution information, set this to false.
    
    Returns:
    the value for addProjectInfo.
  - isAddOsInfo
```
public boolean isAddOsInfo()
```
    Returns the value for addOsInfo.
    Add information about the operating system the build is run in if set to true, skip it, if set to false.
    
    Returns:
    the value for addOsInfo.
  - setAddOsInfo
```
public void setAddOsInfo(boolean addOsInfo)
```
    Sets the value for addOsInfo.
    Add information about the operating system the build is run in if set to true, skip it, if set to false.
    
    Parameters:
    addOsInfo - the value for addOsInfo.
  - getSelectedSystemProperties
```
public List<Property> getSelectedSystemProperties()
```
    Returns the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
    The name is the name of the property, the section is relevant for placing the property in one of the following sections:
    - build.scm
    - build.dateAndVersion
    - build.runtime
    - build.java
    - build.maven
    - build.misc
    If no valid section is given, the property is silently rendered in the build.misc section.
    Returns:
    the list of a system properties to be selected by the user to include into the build meta data properties.
  - setSelectedSystemProperties
```
public void setSelectedSystemProperties(List<Property> selectedSystemProperties)
```
    Sets the list of a system properties or environment variables to be selected by the user to include into the build meta data properties.
    The name is the name of the property, the section is relevant for placing the property in one of the following sections:
    - build.scm
    - build.dateAndVersion
    - build.runtime
    - build.java
    - build.maven
    - build.misc
    If no valid section is given, the property is silently rendered in the build.misc section.
    Parameters:
    selectedSystemProperties - the list of a system properties to be selected by the user to include into the build meta data properties.

Class MavenMetaDataSelection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MavenMetaDataSelection

Method Detail

isAddMavenExecutionInfo

setAddMavenExecutionInfo

isHideCommandLineInfo

setHideCommandLineInfo

isHideMavenOptsInfo

setHideMavenOptsInfo

isHideJavaOptsInfo

setHideJavaOptsInfo

setAddEnvInfo

isAddEnvInfo

isAddJavaRuntimeInfo

setAddJavaRuntimeInfo

setAddProjectInfo

isAddProjectInfo

isAddOsInfo

setAddOsInfo

getSelectedSystemProperties

setSelectedSystemProperties