Package org.odpi.openmetadata.accessservices.datamanager.metadataelements

Class APISpecificationElement

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.metadataelements.APISpecificationElement

All Implemented Interfaces:

Serializable, MetadataElement

public class APISpecificationElement
extends Object
implements MetadataElement, Serializable

APISpecificationElement contains the properties and header for an API Specification (SchemaType) retrieved from the metadata repository.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
APISpecificationElement()	Default constructor
APISpecificationElement(APISpecificationElement 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.
ElementHeader	getElementHeader()	Return the element header associated with the properties.
int	getOperationCount()	Return the count of operations in this API.
APISpecificationProperties	getProperties()	Return the properties for the API specification.
int	hashCode()	Return hash code for this object
void	setElementHeader(ElementHeader elementHeader)	Set up the element header associated with the properties.
void	setOperationCount(int operationCount)	Set up the count of operations in this API
void	setProperties(APISpecificationProperties properties)	Set up the properties for the API specification.
String	toString()	JSON-style toString

Methods inherited from class java.lang.Object

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

Constructor Detail

APISpecificationElement

public APISpecificationElement()

Default constructor

APISpecificationElement

public APISpecificationElement(APISpecificationElement template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getElementHeader

public ElementHeader getElementHeader()

Return the element header associated with the properties.

Specified by:

getElementHeader in interface MetadataElement

Returns:

element header object

setElementHeader

public void setElementHeader(ElementHeader elementHeader)

Set up the element header associated with the properties.

Specified by:

setElementHeader in interface MetadataElement

Parameters:

elementHeader - element header object

getProperties

public APISpecificationProperties getProperties()

Return the properties for the API specification.

Returns:

schema properties (using appropriate subclass)

setProperties

public void setProperties(APISpecificationProperties properties)

Set up the properties for the API specification.

Parameters:

properties - schema properties

getOperationCount

public int getOperationCount()

Return the count of operations in this API.

Returns:

String data type name

setOperationCount

public void setOperationCount(int operationCount)

Set up the count of operations in this API

Parameters:

operationCount - data type name

toString

public String toString()

JSON-style toString

Overrides:

toString in class Object

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 Object

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class Object

Returns:

int hash code