StringMapResponse (egeria 5.2-SNAPSHOT API)

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse

All Implemented Interfaces:: FFDCResponse

public class StringMapResponse extends FFDCResponseBase

StringMapResponse is the response structure used on the OMAS REST API calls that return a map of names to description as a response.

Constructor Summary

Constructors

Constructor

Description

StringMapResponse()

Default constructor

StringMapResponse(StringMapResponse template)

Copy/clone constructor
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Map<String,String>

getStringMap()

Return the name list result.

int

hashCode()

Return hash code for this object

void

setStringMap(Map<String,String> stringMap)

Set up the name to description map result.

String

toString()

JSON-style toString

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- StringMapResponse
  
  public StringMapResponse()
  
  Default constructor
- StringMapResponse
  
  public StringMapResponse(StringMapResponse template)
  
  Copy/clone constructor
  
  Parameters:
  
  template - object to copy
Method Details
- getStringMap
  
  public Map<String,String> getStringMap()
  
  Return the name list result.
  
  Returns:
  
  map of strings
- setStringMap
  
  public void setStringMap(Map<String,String> stringMap)
  
  Set up the name to description map result.
  
  Parameters:
  
  stringMap - map of strings
- toString
  
  public String toString()
  
  JSON-style toString
  
  Overrides:
  
  toString in class FFDCResponseBase
  
  Returns:
  
  return string containing the property names and values
- equals
  
  public boolean equals(Object objectToCompare)
  
  Return comparison result based on the content of the properties.
  
  Overrides:
  
  equals in class FFDCResponseBase
  
  Parameters:
  
  objectToCompare - test object
  
  Returns:
  
  result of comparison
- hashCode
  
  public int hashCode()
  
  Return hash code for this object
  
  Overrides:
  
  hashCode in class FFDCResponseBase
  
  Returns:
  
  int hash code