Class APIParameterProperties
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.SchemaAttributeProperties
-
- org.odpi.openmetadata.accessservices.datamanager.properties.APIParameterProperties
-
- All Implemented Interfaces:
Serializable
public class APIParameterProperties extends SchemaAttributeProperties
APIParameterProperties is a class for representing a parameter in an API specification.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description APIParameterProperties()
Default constructorAPIParameterProperties(APIParameterProperties template)
Copy/clone constructor.APIParameterProperties(SchemaAttributeProperties template)
Copy/clone constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.accessservices.datamanager.properties.SchemaAttributeProperties
getAliases, getAllowsDuplicateValues, getDataType, getDefaultValue, getDefaultValueOverride, getElementPosition, getExternalTypeGUID, getFixedValue, getIsNullable, getLength, getMaxCardinality, getMinCardinality, getMinimumLength, getNativeJavaClass, getOrderedValues, getPrecision, getSortOrder, getValidValuesSetGUID, setAliases, setAllowsDuplicateValues, setDataType, setDefaultValue, setDefaultValueOverride, setElementPosition, setExternalTypeGUID, setFixedValue, setIsNullable, setLength, setMaxCardinality, setMinCardinality, setMinimumLength, setNativeJavaClass, setOrderedValues, setPrecision, setSortOrder, setValidValuesSetGUID
-
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.SchemaElementProperties
getDescription, getDisplayName, getIsDeprecated, setDescription, setDisplayName, setIsDeprecated
-
Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, getVendorProperties, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName, setVendorProperties
-
-
-
-
Constructor Detail
-
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 Detail
-
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 classSchemaAttributeProperties
- 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 classSchemaAttributeProperties
- Parameters:
objectToCompare
- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Create a hash code for this element type.- Overrides:
hashCode
in classSchemaAttributeProperties
- Returns:
- int hash code
-
-