|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.scm.CommandParameters
public class CommandParameters
Constructor Summary | |
---|---|
CommandParameters()
|
Method Summary | |
---|---|
boolean |
getBoolean(CommandParameter parameter)
Return the parameter value as boolean. |
boolean |
getBoolean(CommandParameter parameter,
boolean defaultValue)
Return the parameter value as boolean. |
Date |
getDate(CommandParameter parameter)
Return the parameter value as Date. |
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. |
ScmBranchParameters |
getScmBranchParameters(CommandParameter parameter)
|
ScmTagParameters |
getScmTagParameters(CommandParameter parameter)
|
ScmVersion |
getScmVersion(CommandParameter parameter)
Return the parameter value as ScmVersion. |
ScmVersion |
getScmVersion(CommandParameter parameter,
ScmVersion defaultValue)
Return the parameter value as ScmVersion or the default value. |
String |
getString(CommandParameter parameter)
Return the parameter value as String. |
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. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CommandParameters()
Method Detail |
---|
public String getString(CommandParameter parameter) throws ScmException
parameter
- The parameter
ScmException
- if the parameter doesn't existpublic String getString(CommandParameter parameter, String defaultValue) throws ScmException
parameter
- The parameterdefaultValue
- The default value
ScmException
- if the value is in the wrong typepublic void setString(CommandParameter parameter, String value) throws ScmException
parameter
- The parameter namevalue
- The value of the parameter
ScmException
- if the parameter already existpublic int getInt(CommandParameter parameter) throws ScmException
parameter
- The parameter
ScmException
- if the parameter doesn't existpublic int getInt(CommandParameter parameter, int defaultValue) throws ScmException
parameter
- The parameterdefaultValue
- The defaultValue
ScmException
- if the value is in the wrong typepublic void setInt(CommandParameter parameter, int value) throws ScmException
parameter
- The parameter namevalue
- The value of the parameter
ScmException
- if the parameter already existpublic Date getDate(CommandParameter parameter) throws ScmException
parameter
- The parameter
ScmException
- if the parameter doesn't existpublic Date getDate(CommandParameter parameter, Date defaultValue) throws ScmException
parameter
- The parameterdefaultValue
- The defaultValue
ScmException
- if the value is in the wrong typepublic void setDate(CommandParameter parameter, Date date) throws ScmException
parameter
- The parameter namedate
- The value of the parameter
ScmException
- if the parameter already existpublic boolean getBoolean(CommandParameter parameter) throws ScmException
parameter
- The parameter
ScmException
- if the parameter doesn't existpublic boolean getBoolean(CommandParameter parameter, boolean defaultValue) throws ScmException
parameter
- The parameterdefaultValue
- default value if parameter not exists
ScmException
public ScmVersion getScmVersion(CommandParameter parameter) throws ScmException
parameter
- The parameter
ScmException
- if the parameter doesn't existpublic ScmVersion getScmVersion(CommandParameter parameter, ScmVersion defaultValue) throws ScmException
parameter
- The parameterdefaultValue
- The default value
ScmException
- if the parameter doesn't existpublic void setScmVersion(CommandParameter parameter, ScmVersion scmVersion) throws ScmException
parameter
- The parameter namescmVersion
- The tbranch/tag/revision
ScmException
- if the parameter already existpublic File[] getFileArray(CommandParameter parameter) throws ScmException
parameter
- not null
ScmException
- if anypublic File[] getFileArray(CommandParameter parameter, File[] defaultValue) throws ScmException
parameter
- not nulldefaultValue
- could be null
ScmException
- if anypublic ScmTagParameters getScmTagParameters(CommandParameter parameter) throws ScmException
ScmException
public void setScmTagParameters(CommandParameter parameter, ScmTagParameters scmTagParameters) throws ScmException
ScmException
public void setScmBranchParameters(CommandParameter parameter, ScmBranchParameters scmBranchParameters) throws ScmException
ScmException
public ScmBranchParameters getScmBranchParameters(CommandParameter parameter) throws ScmException
ScmException
public void remove(CommandParameter parameter)
parameter
- name of the parameter to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |