Class APIParameterProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class APIParameterProperties
    extends SchemaAttributeProperties
    APIParameterProperties is a class for representing a parameter in an API specification.
    See Also:
    Serialized Form
    • 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 java.lang.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​(java.lang.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 java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class SchemaAttributeProperties
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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