com.atlassian.confluence.api.model.reference

Class BuilderUtils

java.lang.Object

com.atlassian.confluence.api.model.reference.BuilderUtils

public class BuilderUtils
extends Object

A wrapper around ImmutableList builder that produces immutable lists if elements are added to the builder or a collapsed list otherwise.

Constructor Summary

Constructors

Constructor and Description
BuilderUtils()

Method Summary

Modifier and Type	Method and Description
static <T> List<T>	collapsedList() Create a new (empty) collapsed model list.
static <T> List<T>	collapsedList(Navigation.Builder navBuilder) Create a new (empty) collapsed model list, with a navigation builder set.
static <K,V> Map<K,V>	collapsedMap() Create a new (empty) collapsed model map.
static <K,V> Map<K,V>	collapsedMap(Navigation.Builder navBuilder) Create a new (empty) collapsed model map, with a navigation builder set.
static <T> PageResponse<T>	collapsedPageResponse(Navigation.Builder navBuilder)
static <T> List<T>	immutableListOrCollapsed(com.google.common.collect.ImmutableList.Builder<T> builder) Deprecated. since 5.8 Use a ModelListBuilder.
static <K,V> Map<K,V>	modelMap(com.google.common.collect.ImmutableMap.Builder<? extends K,? extends V> mapBuilder) Deprecated. since 5.6 use modelMap(ModelMapBuilder)
static <K,V> Map<K,V>	modelMap(Map<? extends K,? extends V> map) All API Model maps must be Immutable and either:
static <K,V> Map<K,V>	modelMap(ModelMapBuilder<? extends K,? extends V> mapBuilder) All API Model maps must be Immutable and either:
static <T> com.google.common.collect.ImmutableList.Builder<T>	safelyAddAllToBuilder(com.google.common.collect.ImmutableList.Builder<T> listBuilder, Iterable<? extends T> toAdd) Deprecated. since 5.8 Use a ModelListBuilder.
static <K,V> com.google.common.collect.ImmutableMap.Builder<K,V>	safelyPutAllToBuilder(com.google.common.collect.ImmutableMap.Builder<K,V> mapBuilder, Map<? extends K,? extends V> toAdd) Deprecated. since 5.5.1 Use a ModelMapBuilder.
static <K,V> com.google.common.collect.ImmutableMap.Builder<K,V>	safelyPutToBuilder(com.google.common.collect.ImmutableMap.Builder<K,V> mapBuilder, K key, V value) Deprecated. since 5.5.1 Use a ModelMapBuilder.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuilderUtils

public BuilderUtils()

Method Detail

immutableListOrCollapsed

@Deprecated
public static <T> List<T> immutableListOrCollapsed(com.google.common.collect.ImmutableList.Builder<T> builder)

Deprecated. since 5.8 Use a ModelListBuilder.

collapsedPageResponse

public static <T> PageResponse<T> collapsedPageResponse(Navigation.Builder navBuilder)

collapsedList

public static <T> List<T> collapsedList()

Create a new (empty) collapsed model list.

(If you want to add entries to a list, see ModelListBuilder.)

See Also:

ModelListBuilder

collapsedList

public static <T> List<T> collapsedList(Navigation.Builder navBuilder)

Create a new (empty) collapsed model list, with a navigation builder set.

(If you want to add entries to a list, see ModelListBuilder.)

See Also:

ModelListBuilder

collapsedMap

public static <K,V> Map<K,V> collapsedMap()

Create a new (empty) collapsed model map.

(If you want to add entries to a map, see modelMap(Map) or ModelMapBuilder.)

See Also:

ModelMapBuilder

collapsedMap

public static <K,V> Map<K,V> collapsedMap(Navigation.Builder navBuilder)

Create a new (empty) collapsed model map, with a navigation builder set.

(If you want to add entries to a map, see modelMap(Map) or ModelMapBuilder.)

See Also:

ModelMapBuilder

modelMap

public static <K,V> Map<K,V> modelMap(ModelMapBuilder<? extends K,? extends V> mapBuilder)

All API Model maps must be Immutable and either:

1. Collapsed if null, or 2. RestEnrichable

This method *must* be called when assigning to a model map from a map builder. It is guaranteed to create a correct map from any input.

Returns:

an immutable, API model-friendly map

See Also:

ModelMapBuilder

modelMap

@Deprecated
public static <K,V> Map<K,V> modelMap(com.google.common.collect.ImmutableMap.Builder<? extends K,? extends V> mapBuilder)

Deprecated. since 5.6 use modelMap(ModelMapBuilder)

modelMap

public static <K,V> Map<K,V> modelMap(Map<? extends K,? extends V> map)

All API Model maps must be Immutable and either:

1. Collapsed if null, or 2. RestEnrichable

This method *must* be called when assigning to a model map. It is guaranteed to create a correct map from any input.

Returns:

an immutable, API model-friendly map

safelyPutToBuilder

@Deprecated
public static <K,V> com.google.common.collect.ImmutableMap.Builder<K,V> safelyPutToBuilder(com.google.common.collect.ImmutableMap.Builder<K,V> mapBuilder,
                                                                                                       K key,
                                                                                                       V value)

Deprecated. since 5.5.1 Use a ModelMapBuilder.

safelyPutAllToBuilder

@Deprecated
public static <K,V> com.google.common.collect.ImmutableMap.Builder<K,V> safelyPutAllToBuilder(com.google.common.collect.ImmutableMap.Builder<K,V> mapBuilder,
                                                                                                          Map<? extends K,? extends V> toAdd)

Deprecated. since 5.5.1 Use a ModelMapBuilder.

safelyAddAllToBuilder

@Deprecated
public static <T> com.google.common.collect.ImmutableList.Builder<T> safelyAddAllToBuilder(com.google.common.collect.ImmutableList.Builder<T> listBuilder,
                                                                                                       Iterable<? extends T> toAdd)

Deprecated. since 5.8 Use a ModelListBuilder.