Package com.xwiki.projectmanagement.model

Class Project

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.xwiki.projectmanagement.model.Project

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class Project
extends HashMap<String,Object>

Describes a project coming from a project management platform.

Since:

1.2.0

Version:

$Id$

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_DESCRIPTION	The key identifying the description property of the project.
static String	KEY_IDENTIFIER	The key identifying the identifier property of the project.
static String	KEY_NAME	The key identifying the name property of the project.

Constructor Summary

Constructors

Constructor	Description
Project()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
Linkable	getIdentifier()
Map<String,Object>	getMapEntries()
String	getName()
void	putEntry(String key, Object value)
void	setDescription(String description)
void	setIdentifier(Linkable identifier)
void	setName(String name)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

KEY_IDENTIFIER

public static final String KEY_IDENTIFIER

The key identifying the identifier property of the project.

See Also:

Constant Field Values

KEY_NAME

public static final String KEY_NAME

The key identifying the name property of the project.

See Also:

Constant Field Values

KEY_DESCRIPTION

public static final String KEY_DESCRIPTION

The key identifying the description property of the project.

See Also:

Constant Field Values

Constructor Detail

Project

public Project()

Method Detail

getIdentifier

public Linkable getIdentifier()

Returns:

the identifier for this project together with a link to its location. For example, Open project and GitHub identify work packages numerically: '1001', Jira using a key: 'XWIKI-1001'.

setIdentifier

public void setIdentifier(Linkable identifier)

Parameters:

identifier - see getIdentifier().

getName

public String getName()

Returns:

a user facing, pretty name of the project.

setName

public void setName(String name)

Parameters:

name - see getName()}.

getDescription

public String getDescription()

Returns:

a text that describes this project.

setDescription

public void setDescription(String description)

Parameters:

description - see getDescription().

getMapEntries

public Map<String,Object> getMapEntries()

Returns:

the map.

putEntry

public void putEntry(String key,
                     Object value)

Parameters:

key - the key.

value - the value.