org.xwiki.wikistream.descriptor

Interface WikiStreamDescriptor

All Known Subinterfaces:

WikiStreamBeanDescriptor

All Known Implementing Classes:

AbstractWikiStreamDescriptor, CompositeWikiStreamDescriptor, DefaultWikiStreamBeanDescriptor

@Unstable
public interface WikiStreamDescriptor

Describes a wiki stream.

Since:

5.2M2

Version:

$Id: 193aed94b98fb938c88803a4bfb5869c47e51c68 $

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
String	getName()
Collection<WikiStreamPropertyDescriptor<?>>	getProperties()
<T> WikiStreamPropertyDescriptor<T>	getPropertyDescriptor(String propertyName) Return descriptor for the provided property name.

Method Detail

getName

String getName()

Returns:

human readable name of wiki stream input source type.

getDescription

String getDescription()

Returns:

the description of the wiki stream

getPropertyDescriptor

<T> WikiStreamPropertyDescriptor<T> getPropertyDescriptor(String propertyName)

Return descriptor for the provided property name. The property name is not case sensitive.

Parameters:

propertyName - the name of the property

Returns:

the descriptor of the property.

getProperties

Collection<WikiStreamPropertyDescriptor<?>> getProperties()

Returns:

the properties of wiki stream.