com.atlassian.confluence.api.model
Class Expansions

java.lang.Object
  com.atlassian.confluence.api.model.Expansions

@ExperimentalApi
public class Expansions
extends java.lang.Object

Field Summary

static Expansions

EMPTY

Constructor Summary

Expansions(Expansion... expansions)

Expansions(java.lang.Iterable<Expansion> expansions)

Method Summary

boolean	canExpand(java.lang.String propertyName)
void	checkRecursiveExpansion(java.lang.String expansion) Checks to see if the passed in expansion string is expanded again somewhere in the expansions map.
Expansions	getSubExpansions(java.lang.String propertyName)
boolean	isEmpty()
Expansion[]	merge(Expansion[] expansions)
Expansions	merge(Expansions expansions)
Expansions	prepend(java.lang.String propertyName) Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.
Expansion[]	toArray()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Expansions EMPTY

Constructor Detail

Expansions

public Expansions(Expansion... expansions)

Expansions

public Expansions(java.lang.Iterable<Expansion> expansions)

Method Detail

merge

public Expansions merge(Expansions expansions)

merge

public Expansion[] merge(Expansion[] expansions)

canExpand

public boolean canExpand(java.lang.String propertyName)

getSubExpansions

public Expansions getSubExpansions(java.lang.String propertyName)

prepend

public Expansions prepend(java.lang.String propertyName)

Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.

The new set of expansions will answer true to canExpand(propertyName) and getSubExpansions(propertyName) will return the original set of expansions.

Parameters:

propertyName - - the propertyName to prepend to the set of expansions

Returns:

a new set of expansions with the propertyName at the root of the expansions.

toArray

public Expansion[] toArray()

isEmpty

public boolean isEmpty()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkRecursiveExpansion

public void checkRecursiveExpansion(java.lang.String expansion)

Checks to see if the passed in expansion string is expanded again somewhere in the expansions map. This check is used to prevent recursive expansions.

Parameters:

expansion -