Package org.xwiki.whatsnew
Class NewsSourceDescriptor
- java.lang.Object
-
- org.xwiki.whatsnew.NewsSourceDescriptor
-
@Unstable public class NewsSourceDescriptor extends Object
Defines a news source.- Since:
- 15.1RC1
- Version:
- $Id: 1e9bb8a235864598b108d4c33aee3b9b93591f96 $
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetId()Map<String,String>getParameters()StringgetSourceTypeHint()inthashCode()StringtoString()
-
-
-
Constructor Detail
-
NewsSourceDescriptor
public NewsSourceDescriptor(String id, String sourceTypeHint, Map<String,String> parameters)
- Parameters:
id- seegetId()sourceTypeHint- seegetSourceTypeHint()parameters- seegetParameters()
-
-
Method Detail
-
getId
public String getId()
- Returns:
- the source id (used to identify a source instance, can be any value)
-
getSourceTypeHint
public String getSourceTypeHint()
- Returns:
- the hint to locate the source factory component to create a source object
-
getParameters
public Map<String,String> getParameters()
- Returns:
- the source-specific parameters (e.g. the XWiki Blog source requires a
rssURLparameter)
-
-