Package com.xwiki.projectmanagement.openproject.model

Class BaseOpenProjectObject

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

Direct Known Subclasses:

ColoredOpenProjectObject, Project, User, WorkPackage

public class BaseOpenProjectObject
extends HashMap<String,Object>

Describes the base object for Open Project objects.

Since:

1.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_ID	The key identifying the id property of the open project object.
static String	KEY_NAME	The key identifying the name property of the open project object.

Constructor Summary

Constructors

Constructor	Description
BaseOpenProjectObject()	Default constructor.
BaseOpenProjectObject(com.fasterxml.jackson.databind.JsonNode jsonNode)	Create a BaseOpenProjectObject from a JsonNode.

Method Summary

Modifier and Type	Method	Description
Integer	getId()
Map<String,Object>	getMapEntries()
String	getName()
Linkable	getSelf()	Gets the reference to itself, including their value and reference link.
void	initializeSelfWithPath(String connectionUrl, String resourcePath)	Initializes the self link of the object from a connection URL and a resource path.
void	putEntry(String key, Object value)
void	setId(int id)
void	setName(String name)
void	setSelf(Linkable self)	Sets the reference to itself, including their value and reference link.

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_ID

public static final String KEY_ID

The key identifying the id property of the open project object.

See Also:

Constant Field Values

KEY_NAME

public static final String KEY_NAME

The key identifying the name property of the open project object.

See Also:

Constant Field Values

Constructor Detail

BaseOpenProjectObject

public BaseOpenProjectObject()

Default constructor.

BaseOpenProjectObject

public BaseOpenProjectObject(com.fasterxml.jackson.databind.JsonNode jsonNode)

Create a BaseOpenProjectObject from a JsonNode.

Parameters:

jsonNode - the JsonNode containing the base open project object information.

Method Detail

getId

public Integer getId()

Returns:

the id of the work item project.

setId

public void setId(int id)

Parameters:

id - see getId().

getName

public String getName()

Returns:

the name of the work item project.

setName

public void setName(String name)

Parameters:

name - see getName().

getSelf

public Linkable getSelf()

Gets the reference to itself, including their value and reference link.

Returns:

the assignee as a Linkable

setSelf

public void setSelf(Linkable self)

Sets the reference to itself, including their value and reference link.

Parameters:

self - the self to set as a Linkable

getMapEntries

public Map<String,Object> getMapEntries()

Returns:

the map.

putEntry

public void putEntry(String key,
                     Object value)

Parameters:

key - the key.

value - the value.

initializeSelfWithPath

public void initializeSelfWithPath(String connectionUrl,
                                   String resourcePath)

Initializes the self link of the object from a connection URL and a resource path.

Parameters:

connectionUrl - the connection URL to the Open Project instance.

resourcePath - the resource path of the resource.

Since:

1.1