Package com.intellij.execution.configurations

Class ParametersList

java.lang.Object

com.intellij.execution.configurations.ParametersList

All Implemented Interfaces:

java.lang.Cloneable

public final class ParametersList
extends java.lang.Object
implements java.lang.Cloneable

A list of command-line parameters featuring the following:

• special handling for Java properties (-D<name>=<value>)
• macro substitution upon addition for plain parameters, and property values
• named groups for parameters
• parameter strings with quoted parameters

See Also:

defineProperty(String, String), expandMacros(String), addParamsGroup(String), addParametersString(String), ParamsGroup

Constructor Summary

Constructors

Constructor and Description
ParametersList()

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String parameter)
void	add(java.lang.String name, java.lang.String value)
void	addAll(java.util.List<java.lang.String> parameters)
void	addAll(java.lang.String... parameters)
void	addAt(int index, java.lang.String parameter)
void	addNotEmptyProperty(java.lang.String propertyName, java.lang.String propertyValue) Adds -D<propertyName>=<propertyValue> to the list ignoring null, empty and spaces-only values; replaces the value of the last property if defined.
void	addParametersString(java.lang.String parameters)
ParamsGroup	addParamsGroup(ParamsGroup group)
ParamsGroup	addParamsGroup(java.lang.String groupId)
ParamsGroup	addParamsGroupAt(int index, ParamsGroup group)
ParamsGroup	addParamsGroupAt(int index, java.lang.String groupId)
void	addProperty(java.lang.String propertyName) Adds -D<propertyName> to the list; replaces the value of the last property if defined.
void	addProperty(java.lang.String propertyName, java.lang.String propertyValue) Adds -D<propertyName>=<propertyValue> to the list ignoring null values; replaces the value of the last property if defined.
void	clearAll()
ParametersList	clone()
void	defineProperty(java.lang.String propertyName, java.lang.String propertyValue) Keeps the <propertyName> property if defined; otherwise appends the new one ignoring null values.
void	defineSystemProperty(java.lang.String propertyName) Keeps the <propertyName> property if defined; or defines it with System.getProperty() as a value if present.
java.lang.String	expandMacros(java.lang.String text)
java.lang.String	get(int ind)
java.lang.String []	getArray()
java.lang.String	getLast()
java.util.List<java.lang.String>	getList()
java.util.List<java.lang.String>	getParameters()
java.lang.String	getParametersString()
ParamsGroup	getParamsGroup(java.lang.String name)
ParamsGroup	getParamsGroupAt(int index)
java.util.List<ParamsGroup>	getParamsGroups()
int	getParamsGroupsCount()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.util.Map<java.lang.String,java.lang.String>	getProperties(java.lang.String valueIfMissing)
java.lang.String	getPropertyValue(java.lang.String propertyName)
boolean	hasParameter(java.lang.String parameter)
boolean	hasProperty(java.lang.String propertyName)
static java.lang.String	join(java.util.List<java.lang.String> parameters)
static java.lang.String	join(java.lang.String... parameters)
static java.lang.String []	parse(java.lang.String string)
void	prepend(java.lang.String parameter)
void	prependAll(java.lang.String... parameter)
ParamsGroup	removeParamsGroup(int index)
void	replaceOrAppend(java.lang.String parameterPrefix, java.lang.String replacement) Replaces the last parameter that starts with the <parameterPrefix> with <replacement>; otherwise appends <replacement> to the list.
void	replaceOrPrepend(java.lang.String parameterPrefix, java.lang.String replacement) Replaces the last parameter that starts with the <parameterPrefix> with <replacement>; otherwise prepends this list with <replacement>.
void	set(int ind, java.lang.String value)
static void	setTestMacros(java.util.Map<java.lang.String,java.lang.String> testMacros)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParametersList

public ParametersList()

Method Detail

hasParameter

public boolean hasParameter(java.lang.String parameter)

hasProperty

public boolean hasProperty(java.lang.String propertyName)

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propertyName)

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties(java.lang.String valueIfMissing)

getParametersString

public java.lang.String getParametersString()

getArray

public java.lang.String [] getArray()

getList

public java.util.List<java.lang.String> getList()

clearAll

public void clearAll()

prepend

public void prepend(java.lang.String parameter)

prependAll

public void prependAll(java.lang.String... parameter)

addParametersString

public void addParametersString(java.lang.String parameters)

add

public void add(java.lang.String parameter)

addParamsGroup

public ParamsGroup addParamsGroup(java.lang.String groupId)

addParamsGroup

public ParamsGroup addParamsGroup(ParamsGroup group)

addParamsGroupAt

public ParamsGroup addParamsGroupAt(int index,
                                    ParamsGroup group)

addParamsGroupAt

public ParamsGroup addParamsGroupAt(int index,
                                    java.lang.String groupId)

getParamsGroupsCount

public int getParamsGroupsCount()

getParameters

public java.util.List<java.lang.String> getParameters()

getParamsGroups

public java.util.List<ParamsGroup> getParamsGroups()

getParamsGroupAt

public ParamsGroup getParamsGroupAt(int index)

getParamsGroup

public ParamsGroup getParamsGroup(java.lang.String name)

removeParamsGroup

public ParamsGroup removeParamsGroup(int index)

addAt

public void addAt(int index,
                  java.lang.String parameter)

defineSystemProperty

public void defineSystemProperty(java.lang.String propertyName)

Keeps the <propertyName> property if defined; or defines it with System.getProperty() as a value if present.

defineProperty

public void defineProperty(java.lang.String propertyName,
                           java.lang.String propertyValue)

Keeps the <propertyName> property if defined; otherwise appends the new one ignoring null values.

addProperty

public void addProperty(java.lang.String propertyName)

Adds -D<propertyName> to the list; replaces the value of the last property if defined.

addProperty

public void addProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)

Adds -D<propertyName>=<propertyValue> to the list ignoring null values; replaces the value of the last property if defined.

addNotEmptyProperty

public void addNotEmptyProperty(java.lang.String propertyName,
                                java.lang.String propertyValue)

Adds -D<propertyName>=<propertyValue> to the list ignoring null, empty and spaces-only values; replaces the value of the last property if defined.

replaceOrAppend

public void replaceOrAppend(java.lang.String parameterPrefix,
                            java.lang.String replacement)

Replaces the last parameter that starts with the <parameterPrefix> with <replacement>; otherwise appends <replacement> to the list.

replaceOrPrepend

public void replaceOrPrepend(java.lang.String parameterPrefix,
                             java.lang.String replacement)

Replaces the last parameter that starts with the <parameterPrefix> with <replacement>; otherwise prepends this list with <replacement>.

set

public void set(int ind,
                java.lang.String value)

get

public java.lang.String get(int ind)

getLast

public java.lang.String getLast()

add

public void add(java.lang.String name,
                java.lang.String value)

addAll

public void addAll(java.lang.String... parameters)

addAll

public void addAll(java.util.List<java.lang.String> parameters)

clone

public ParametersList clone()

Overrides:

clone in class java.lang.Object

join

public static java.lang.String join(java.util.List<java.lang.String> parameters)

See Also:

ParametersListUtil.join(List)

join

public static java.lang.String join(java.lang.String... parameters)

See Also:

ParametersListUtil.join(List)

parse

public static java.lang.String [] parse(java.lang.String string)

See Also:

ParametersListUtil.parseToArray(String)

expandMacros

public java.lang.String expandMacros(java.lang.String text)

setTestMacros

public static void setTestMacros(java.util.Map<java.lang.String,java.lang.String> testMacros)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object