org.xwiki.wikistream.descriptor

Class AbstractWikiStreamDescriptor

java.lang.Object

org.xwiki.wikistream.descriptor.AbstractWikiStreamDescriptor

All Implemented Interfaces:

WikiStreamDescriptor

Direct Known Subclasses:

CompositeWikiStreamDescriptor, DefaultWikiStreamBeanDescriptor

@Unstable
public abstract class AbstractWikiStreamDescriptor
extends Object
implements WikiStreamDescriptor

Since:

5.3M2

Version:

$Id: 874bb74070d96e19e70c3cce2ee5af3c1b2e06c0 $

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description The description of the macro.
protected String	name
protected Map<String,WikiStreamPropertyDescriptor<?>>	parameterDescriptorMap A map containing the WikiStreamPropertyDescriptor for each parameters supported for this wiki stream.

Constructor Summary

Constructors

Constructor and Description
AbstractWikiStreamDescriptor(String name, String description)

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.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

See Also:

getName()

description

protected String description

The description of the macro.

parameterDescriptorMap

protected Map<String,WikiStreamPropertyDescriptor<?>> parameterDescriptorMap

A map containing the WikiStreamPropertyDescriptor for each parameters supported for this wiki stream.

The Map keys are lower cased for easier case insensitive search, to get the "real" name of the property use WikiStreamPropertyDescriptor.getName().

Constructor Detail

AbstractWikiStreamDescriptor

public AbstractWikiStreamDescriptor(String name,
                            String description)

Parameters:

name - human readable name of wiki stream input source type.

description - the description of the wiki stream

Method Detail

getName

public String getName()

Specified by:

getName in interface WikiStreamDescriptor

Returns:

human readable name of wiki stream input source type.

getDescription

public String getDescription()

Specified by:

getDescription in interface WikiStreamDescriptor

Returns:

the description of the wiki stream

getPropertyDescriptor

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

Description copied from interface: WikiStreamDescriptor

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

Specified by:

getPropertyDescriptor in interface WikiStreamDescriptor

Parameters:

propertyName - the name of the property

Returns:

the descriptor of the property.

getProperties

public Collection<WikiStreamPropertyDescriptor<?>> getProperties()

Specified by:

getProperties in interface WikiStreamDescriptor

Returns:

the properties of wiki stream.