Class PathVariable


  • @OpenApi
    public class PathVariable
    extends java.lang.Object
    Path Variable definition.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String mDescription
      Description
      private java.lang.String mName
      Path variable name
      private java.lang.String mPath
      Path variable value
    • Constructor Summary

      Constructors 
      Constructor Description
      PathVariable​(java.lang.String name, java.lang.String path, java.lang.String description)
      Constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Get variable description.
      java.lang.String getName()
      Get variable name.
      java.lang.String getPath()
      Get variable path.
      void setDescription​(java.lang.String description)
      Set variable description.
      void setName​(java.lang.String name)
      Set variable name.
      void setPath​(java.lang.String path)
      Set variable path.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • mName

        private java.lang.String mName
        Path variable name
      • mPath

        private java.lang.String mPath
        Path variable value
      • mDescription

        private java.lang.String mDescription
        Description
    • Constructor Detail

      • PathVariable

        @OpenApi
        public PathVariable​(java.lang.String name,
                            java.lang.String path,
                            java.lang.String description)
        Constructor.
        Parameters:
        name - variable name.
        path - path.
        description - description.
    • Method Detail

      • getName

        @OpenApi
        public java.lang.String getName()
        Get variable name.
        Returns:
        name.
      • setName

        public void setName​(java.lang.String name)
        Set variable name.
        Parameters:
        name - name.
      • getPath

        @OpenApi
        public java.lang.String getPath()
        Get variable path.
        Returns:
        path.
      • setPath

        public void setPath​(java.lang.String path)
        Set variable path.
        Parameters:
        path - path.
      • getDescription

        @OpenApi
        public java.lang.String getDescription()
        Get variable description.
        Returns:
        description.
      • setDescription

        public void setDescription​(java.lang.String description)
        Set variable description.
        Parameters:
        description - description.