Package org.apache.maven.scm
Class CommandParameters
java.lang.Object
org.apache.maven.scm.CommandParameters
- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
getBoolean
(CommandParameter parameter) Return the parameter value as boolean.boolean
getBoolean
(CommandParameter parameter, boolean defaultValue) Return the parameter value as boolean.getDate
(CommandParameter parameter) Return the parameter value as Date.getDate
(CommandParameter parameter, Date defaultValue) Return the parameter value as String or the default value if it doesn't exist.File[]
getFileArray
(CommandParameter parameter) File[]
getFileArray
(CommandParameter parameter, File[] defaultValue) int
getInt
(CommandParameter parameter) Return the parameter value as int.int
getInt
(CommandParameter parameter, int defaultValue) Return the parameter value as int or the default value if it doesn't exist.private Object
getObject
(Class<?> clazz, CommandParameter parameter) Return the value object.private Object
getObject
(Class<?> clazz, CommandParameter parameter, Object defaultValue) Return the value object or the default value if it doesn't exist.getScmBranchParameters
(CommandParameter parameter) getScmTagParameters
(CommandParameter parameter) getScmVersion
(CommandParameter parameter) Return the parameter value as ScmVersion.getScmVersion
(CommandParameter parameter, ScmVersion defaultValue) Return the parameter value as ScmVersion or the default value.getString
(CommandParameter parameter) Return the parameter value as String.getString
(CommandParameter parameter, String defaultValue) Return the parameter value or the default value if it doesn't exist.void
remove
(CommandParameter parameter) Removes a parameter, silent if it didn't exist.void
setDate
(CommandParameter parameter, Date date) Set a parameter value.void
setInt
(CommandParameter parameter, int value) Set a parameter value.private void
setObject
(CommandParameter parameter, Object value) Set the parameter value.void
setScmBranchParameters
(CommandParameter parameter, ScmBranchParameters scmBranchParameters) void
setScmTagParameters
(CommandParameter parameter, ScmTagParameters scmTagParameters) void
setScmVersion
(CommandParameter parameter, ScmVersion scmVersion) Set a parameter value.void
setString
(CommandParameter parameter, String value) Set a parameter value.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
parameters
-
-
Constructor Details
-
CommandParameters
public CommandParameters()
-
-
Method Details
-
getString
Return the parameter value as String.- Parameters:
parameter
- The parameter- Returns:
- The parameter value as a String
- Throws:
ScmException
- if the parameter doesn't exist
-
getString
Return the parameter value or the default value if it doesn't exist.- Parameters:
parameter
- The parameterdefaultValue
- The default value- Returns:
- The parameter value as a String
- Throws:
ScmException
- if the value is in the wrong type
-
setString
Set a parameter value.- Parameters:
parameter
- The parameter namevalue
- The value of the parameter- Throws:
ScmException
- if the parameter already exist
-
getInt
Return the parameter value as int.- Parameters:
parameter
- The parameter- Returns:
- The parameter value as a String
- Throws:
ScmException
- if the parameter doesn't exist
-
getInt
Return the parameter value as int or the default value if it doesn't exist.- Parameters:
parameter
- The parameterdefaultValue
- The defaultValue- Returns:
- The parameter value as a int
- Throws:
ScmException
- if the value is in the wrong type
-
setInt
Set a parameter value.- Parameters:
parameter
- The parameter namevalue
- The value of the parameter- Throws:
ScmException
- if the parameter already exist
-
getDate
Return the parameter value as Date.- Parameters:
parameter
- The parameter- Returns:
- The parameter value as a Date
- Throws:
ScmException
- if the parameter doesn't exist
-
getDate
Return the parameter value as String or the default value if it doesn't exist.- Parameters:
parameter
- The parameterdefaultValue
- The defaultValue- Returns:
- The parameter value as a Date
- Throws:
ScmException
- if the value is in the wrong type
-
setDate
Set a parameter value.- Parameters:
parameter
- The parameter namedate
- The value of the parameter- Throws:
ScmException
- if the parameter already exist
-
getBoolean
Return the parameter value as boolean.- Parameters:
parameter
- The parameter- Returns:
- The parameter value as a boolean
- Throws:
ScmException
- if the parameter doesn't exist
-
getBoolean
Return the parameter value as boolean.- Parameters:
parameter
- The parameterdefaultValue
- default value if parameter not exists- Returns:
- The parameter value as a boolean
- Throws:
ScmException
- Since:
- 1.7
-
getScmVersion
Return the parameter value as ScmVersion.- Parameters:
parameter
- The parameter- Returns:
- The parameter value as a ScmVersion
- Throws:
ScmException
- if the parameter doesn't exist
-
getScmVersion
public ScmVersion getScmVersion(CommandParameter parameter, ScmVersion defaultValue) throws ScmException Return the parameter value as ScmVersion or the default value.- Parameters:
parameter
- The parameterdefaultValue
- The default value- Returns:
- The parameter value as a ScmVersion
- Throws:
ScmException
- if the parameter doesn't exist
-
setScmVersion
Set a parameter value.- Parameters:
parameter
- The parameter namescmVersion
- The tbranch/tag/revision- Throws:
ScmException
- if the parameter already exist
-
getFileArray
- Parameters:
parameter
- not null- Returns:
- an array of files
- Throws:
ScmException
- if any
-
getFileArray
- Parameters:
parameter
- not nulldefaultValue
- could be null- Returns:
- an array of files
- Throws:
ScmException
- if any
-
getScmTagParameters
- Throws:
ScmException
-
setScmTagParameters
public void setScmTagParameters(CommandParameter parameter, ScmTagParameters scmTagParameters) throws ScmException - Throws:
ScmException
-
setScmBranchParameters
public void setScmBranchParameters(CommandParameter parameter, ScmBranchParameters scmBranchParameters) throws ScmException - Throws:
ScmException
-
getScmBranchParameters
- Throws:
ScmException
-
getObject
Return the value object.- Parameters:
clazz
- The type of the parameter valueparameter
- The parameter- Returns:
- The parameter value
- Throws:
ScmException
- if the parameter doesn't exist
-
getObject
private Object getObject(Class<?> clazz, CommandParameter parameter, Object defaultValue) throws ScmException Return the value object or the default value if it doesn't exist.- Parameters:
clazz
- The type of the parameter valueparameter
- The parameterdefaultValue
- The defaultValue- Returns:
- The parameter value
- Throws:
ScmException
- if the defaultValue is in the wrong type
-
setObject
Set the parameter value.- Parameters:
parameter
- The parametervalue
- The parameter value- Throws:
ScmException
- if the parameter already exist
-
remove
Removes a parameter, silent if it didn't exist.- Parameters:
parameter
- to remove
-