Package com.atlassian.confluence.rest.api.model

Class ExpansionsParser

java.lang.Object

com.atlassian.confluence.rest.api.model.ExpansionsParser

@ExperimentalApi
public class ExpansionsParser
extends Object

Converts Expansions to and from a String for use with REST calls.

Constructor Summary

Constructors

Constructor	Description
ExpansionsParser()

Method Summary

Modifier and Type	Method	Description
static String	asString(Expansion[] expansionsArr)	Converts a collection of Expansions into a single string.
static String	asString(Expansions expansions)	Converts a Expansions collection into a single string.
static Expansion[]	parse(@Nullable String expand)	Converts a string representation of a collection of Expansions back into an Expansion array.
static Expansions	parse(String... individualExpansions)
static Expansions	parseAsExpansions(String expand)	Converts a string representation of a collection of Expansions into an Expansions instance.
static Expansion[]	parseExperimental(@Nullable String expand)	Converts a string representation of a collection of Expansions back into an Expansion array.
static Expansions	parseExperimental(String... individualExpansions)
static Expansions	parseExperimentalAsExpansions(String expand)	Same as calling parseAsExpansions(java.lang.String), but allows for experimental expansions.
static Expansion	parseExperimentalSingle(String expand)	Same as calling parseSingle(java.lang.String), but allows for experimental expansions.
static Expansions	parseExperimentalWithPrefix(String prefix, String expansions)
static Expansion	parseSingle(String expand)	Converts a string representation of a single Expansion back into an Expansion.
static Expansions	parseWithPrefix(String prefix, String expansions)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpansionsParser

public ExpansionsParser()

Method Detail

parse

public static Expansion[] parse(@Nullable String expand)

Converts a string representation of a collection of Expansions back into an Expansion array. If a property matches something in ExpansionsParser.ExpansionsParserImpl.EXPERIMENTAL_EXPANSIONS, it will be ignored. Use parseExperimental(String...) to allow experimental properties to be expanded.

parseExperimental

public static Expansion[] parseExperimental(@Nullable String expand)

Converts a string representation of a collection of Expansions back into an Expansion array.

Same as calling parse(String), but allows for experimental expansions. These experimental expansions will only be matched if the expand string given is in ExpansionsParser.ExpansionsParserImpl.EXPERIMENTAL_EXPANSIONS.

Parameters:

expand - the expansion strings, separated by commas

Returns:

an expansion array containing all of the individual expansions.

parseAsExpansions

public static Expansions parseAsExpansions(String expand)

Converts a string representation of a collection of Expansions into an Expansions instance.

parseExperimentalAsExpansions

public static Expansions parseExperimentalAsExpansions(String expand)

Same as calling parseAsExpansions(java.lang.String), but allows for experimental expansions. These experimental expansions will only be matched if the expand string given is in ExpansionsParser.ExpansionsParserImpl.EXPERIMENTAL_EXPANSIONS.

parseSingle

public static Expansion parseSingle(String expand)

Converts a string representation of a single Expansion back into an Expansion.

parseExperimentalSingle

public static Expansion parseExperimentalSingle(String expand)

Same as calling parseSingle(java.lang.String), but allows for experimental expansions. These experimental expansions will only be matched if the expand string given is in ExpansionsParser.ExpansionsParserImpl.EXPERIMENTAL_EXPANSIONS.

asString

public static String asString(Expansions expansions)

Converts a Expansions collection into a single string.

asString

public static String asString(Expansion[] expansionsArr)

Converts a collection of Expansions into a single string.

parse

public static Expansions parse(String... individualExpansions)

parseExperimental

public static Expansions parseExperimental(String... individualExpansions)

parseWithPrefix

public static Expansions parseWithPrefix(String prefix,
                                         String expansions)

parseExperimentalWithPrefix

public static Expansions parseExperimentalWithPrefix(String prefix,
                                                     String expansions)