com.atlassian.confluence.api.extension

Class MetadataProperty

java.lang.Object

com.atlassian.confluence.api.extension.MetadataProperty

public class MetadataProperty
extends Object

Describes a meta-data property that's returned from ModelMetadataProvider.

Since:

6.12.0

Constructor Summary

Constructors

Constructor and Description
MetadataProperty(String propertyName, List<MetadataProperty> children)
MetadataProperty(String propertyName, Type propertyType)

Method Summary

Modifier and Type	Method and Description
List<MetadataProperty>	getChildren() Get the child properties, that are specified without a java type.
String	getPropertyName() Get the name of the property.
@Nullable Type	getPropertyType() Get the java type of the property, or null if there are child properties instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataProperty

public MetadataProperty(String propertyName,
                        Type propertyType)

MetadataProperty

public MetadataProperty(String propertyName,
                        List<MetadataProperty> children)

Method Detail

getPropertyName

public String getPropertyName()

Get the name of the property.

getPropertyType

public @Nullable Type getPropertyType()

Get the java type of the property, or null if there are child properties instead. The type may be a simple type (String, Integer etc), or a complex type annotated with json serialization annotations.

getChildren

public List<MetadataProperty> getChildren()

Get the child properties, that are specified without a java type. A property that has a propertyType will not have dynamic child properties.