com.atlassian.confluence.api.model
Class Expansion

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

@ExperimentalApi
public class Expansion
extends Object

Represents a property on a model object and the sub-properties of that property that should be filled in by the service when returning the model object. This allows the service to only provide as much information in the model as required by the requester. Use the ExpansionsParser to produce expansions from dot delimited strings.

Field Summary

static com.google.common.base.Function<String,Expansion>

AS_EXPANSION

Constructor Summary

Expansion(String propertyName)

Expansion(String propertyName, Expansions subExpansions)

Method Summary

static Expansion	combine(Object... expansionParts) Creates an Expansion made up of the given parts.
boolean	equals(Object o)
String	getPropertyName()
Expansions	getSubExpansions()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

AS_EXPANSION

public static final com.google.common.base.Function<String,Expansion> AS_EXPANSION

Constructor Detail

Expansion

public Expansion(String propertyName)

Expansion

public Expansion(String propertyName,
                 Expansions subExpansions)

Method Detail

getPropertyName

public String getPropertyName()

getSubExpansions

public Expansions getSubExpansions()

combine

public static Expansion combine(Object... expansionParts)

Creates an Expansion made up of the given parts. e.g calling combine("a", "b", "c") will return an Expansion for "a.b.c"

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object