Package org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis

Class APIParameterProperties

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties

org.odpi.openmetadata.frameworks.openmetadata.properties.schema.apis.APIParameterProperties

public class APIParameterProperties
extends SchemaAttributeProperties

APIParameterProperties is a class for representing a parameter in an API specification.

Constructor Summary

Constructors

Constructor	Description
APIParameterProperties()	Default constructor
APIParameterProperties(APIParameterProperties template)	Copy/clone constructor.
APIParameterProperties(SchemaAttributeProperties template)	Copy/clone constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getParameterType()	Return the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?
int	hashCode()	Create a hash code for this element type.
void	setParameterType(String parameterType)	Set up the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties

getAliases, getAllowsDuplicateValues, getDataType, getDefaultValue, getDefaultValueOverride, getElementPosition, getExternalTypeGUID, getFixedValue, getIsNullable, getLength, getMaxCardinality, getMinCardinality, getMinimumLength, getNativeJavaClass, getOrderedValues, getPrecision, getSchemaType, getSignificantDigits, getSortOrder, getValidValuesSetGUID, setAliases, setAllowsDuplicateValues, setDataType, setDefaultValue, setDefaultValueOverride, setElementPosition, setExternalTypeGUID, setFixedValue, setIsNullable, setLength, setMaxCardinality, setMinCardinality, setMinimumLength, setNativeJavaClass, setOrderedValues, setPrecision, setSchemaType, setSignificantDigits, setSortOrder, setValidValuesSetGUID

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties

getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties

getAdditionalProperties, getQualifiedName, getVendorProperties, setAdditionalProperties, setQualifiedName, setVendorProperties

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties

getEffectiveFrom, getEffectiveTo, getExtendedProperties, getTypeName, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setTypeName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

APIParameterProperties

public APIParameterProperties()

Default constructor

APIParameterProperties

public APIParameterProperties(APIParameterProperties template)

Copy/clone constructor.

Parameters:

template - object to copy

APIParameterProperties

public APIParameterProperties(SchemaAttributeProperties template)

Copy/clone constructor.

Parameters:

template - object to copy

Method Details

getParameterType

public String getParameterType()

Return the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?

Returns:

string name

setParameterType

public void setParameterType(String parameterType)

Set up the type of parameter - for example for REST APIs, is it a PathVariable or a RequestParameter?

Parameters:

parameterType - string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class SchemaAttributeProperties

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class SchemaAttributeProperties

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class SchemaAttributeProperties

Returns:

int hash code