org.apache.sling.caconfig.spi.metadata

Class ConfigurationMetadata

java.lang.Object

org.apache.sling.caconfig.spi.metadata.ConfigurationMetadata

@ProviderType
public final class ConfigurationMetadata
extends java.lang.Object

Defines a configuration.

Constructor Summary

Constructors

Constructor and Description
ConfigurationMetadata(java.lang.String name, java.util.Collection<PropertyMetadata<?>> propertyMetadata, boolean collection)

Method Summary

Modifier and Type	Method and Description
T	description(java.lang.String description)
java.lang.String	getDescription()
java.lang.String	getLabel()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.util.Map<java.lang.String,PropertyMetadata<?>>	getPropertyMetadata()
boolean	isCollection()
boolean	isSingleton()
T	label(java.lang.String label)
T	properties(java.util.Map<java.lang.String,java.lang.String> properties)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMetadata

public ConfigurationMetadata(@Nonnull
                             java.lang.String name,
                             java.util.Collection<PropertyMetadata<?>> propertyMetadata,
                             boolean collection)

Parameters:

name - Configuration name

propertyMetadata - Property metadata

collection - Collection

Method Detail

isSingleton

public boolean isSingleton()

Returns:

true if configuration is singleton

isCollection

public boolean isCollection()

Returns:

true if configuration is collection

getPropertyMetadata

public java.util.Map<java.lang.String,PropertyMetadata<?>> getPropertyMetadata()

Returns:

Configuration properties

getName

@Nonnull
public java.lang.String getName()

Returns:

Parameter name

getLabel

public java.lang.String getLabel()

Returns:

Label

label

public T label(java.lang.String label)

Parameters:

label - Label

Returns:

this;

getDescription

public java.lang.String getDescription()

Returns:

Description

description

public T description(java.lang.String description)

Parameters:

description - Description

Returns:

this;

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns:

Further properties for documentation and configuration of behavior in configuration editor.

properties

public T properties(java.util.Map<java.lang.String,java.lang.String> properties)

Parameters:

properties - Further properties for documentation and configuration of behavior in configuration editor.

Returns:

this;

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object