Package com.intellij.util.execution

Class ParametersListUtil

java.lang.Object

com.intellij.util.execution.ParametersListUtil

public final class ParametersListUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static Function<java.util.List<java.lang.String>,java.lang.String>	COLON_LINE_JOINER
static Function<java.lang.String,java.util.List<java.lang.String>>	COLON_LINE_PARSER
static Function<java.util.List<java.lang.String>,java.lang.String>	DEFAULT_LINE_JOINER
static Function<java.lang.String,java.util.List<java.lang.String>>	DEFAULT_LINE_PARSER

Constructor Summary

Constructors

Constructor and Description
ParametersListUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escape(java.lang.CharSequence argument) Escapes a single argument.
static java.lang.String	join(java.util.List<? extends java.lang.CharSequence> parameters) Joins list of parameters into single string, which may be then parsed back into list by parseToArray(String).
static <T extends java.lang.CharSequence> java.lang.String	join(java.util.List<? extends T> parameters, Function<? super T,? extends java.lang.CharSequence> escapeFunction)
static java.lang.String	join(java.lang.String... parameters)
static java.util.List<java.lang.String>	parse(java.lang.String parameterString) Splits single parameter string (as created by join(List)) into list of parameters.
static java.util.List<java.lang.String>	parse(java.lang.String parameterString, boolean keepQuotes)
static java.util.List<java.lang.String>	parse(java.lang.String parameterString, boolean keepQuotes, boolean supportSingleQuotes)
static java.util.List<java.lang.String>	parse(java.lang.String parameterString, boolean keepQuotes, boolean supportSingleQuotes, boolean keepEmptyParameters)
static java.lang.String []	parseToArray(java.lang.String string)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LINE_PARSER

public static final Function<java.lang.String,java.util.List<java.lang.String>> DEFAULT_LINE_PARSER

DEFAULT_LINE_JOINER

public static final Function<java.util.List<java.lang.String>,java.lang.String> DEFAULT_LINE_JOINER

COLON_LINE_PARSER

public static final Function<java.lang.String,java.util.List<java.lang.String>> COLON_LINE_PARSER

COLON_LINE_JOINER

public static final Function<java.util.List<java.lang.String>,java.lang.String> COLON_LINE_JOINER

Constructor Detail

ParametersListUtil

public ParametersListUtil()

Method Detail

join

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

Joins list of parameters into single string, which may be then parsed back into list by parseToArray(String).

Conversion rules:

• double quotes are escaped by backslash (\);
• empty parameters parameters and parameters with spaces inside are surrounded with double quotes (");
• parameters are separated by single whitespace.

Examples:

['a', 'b'] => 'a b'
['a="1 2"', 'b'] => '"a \"1 2\"" b'

Parameters:

parameters - a list of parameters to join.

Returns:

a string with parameters.

join

public static <T extends java.lang.CharSequence> java.lang.String join(java.util.List<? extends T> parameters,
                                                                       Function<? super T,? extends java.lang.CharSequence> escapeFunction)

Parameters:

escapeFunction - defines how to handle (quote/escape) special characters in each command line argument

See Also:

join(List)

join

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

parseToArray

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

See Also:

parse(String)

parse

public static java.util.List<java.lang.String> parse(java.lang.String parameterString)

Splits single parameter string (as created by join(List)) into list of parameters.

Conversion rules:

• starting/whitespaces are trimmed;
• parameters are split by whitespaces, whitespaces itself are dropped
• parameters inside double quotes ("a b") are kept as single one;
• double quotes are dropped, escaped double quotes (\") are un-escaped.
• For single quotes support see parse(String, boolean, boolean)

Examples:

' a b ' => ['a', 'b']
'a="1 2" b' => ['a=1 2', 'b']
'a " " b' => ['a', ' ', 'b']
'"a \"1 2\"" b' => ['a="1 2"', 'b']

Parameters:

parameterString - parameter string to split.

Returns:

array of parameters.

parse

public static java.util.List<java.lang.String> parse(java.lang.String parameterString,
                                                     boolean keepQuotes)

parse

public static java.util.List<java.lang.String> parse(java.lang.String parameterString,
                                                     boolean keepQuotes,
                                                     boolean supportSingleQuotes)

parse

public static java.util.List<java.lang.String> parse(java.lang.String parameterString,
                                                     boolean keepQuotes,
                                                     boolean supportSingleQuotes,
                                                     boolean keepEmptyParameters)

escape

public static java.lang.String escape(java.lang.CharSequence argument)

Escapes a single argument. The escaping strategy conforms to the implementation of parse(java.lang.String) so that the following invariants are held:

   assert parse(escape(arg)).size() == 1;
   assert parse(escape(arg)).get(0).equals(arg);