Package kong.unirest.core

Class Path

  • public class Path
extends java.lang.Object
    Class for building a URI with query params

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String rawPath  
      private java.lang.String url  

    • Constructor Summary

      Constructors 
      Constructor Description
      Path​(java.lang.String url)
      construct a path
      Path​(java.lang.String url, java.lang.String defaultBasePath)
      Construct a path with a URL that could be relative and a default base for it

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String baseUrl()  
      private java.lang.String encodePath​(java.lang.String value)  
      boolean equals​(java.lang.Object o)  
      private java.lang.String escape​(java.lang.String string)  
      java.lang.String getQueryString()  
      int hashCode()  
      void param​(java.lang.String name, java.lang.String value)
      replace a single path param by name
      void param​(java.util.Map<java.lang.String,​java.lang.Object> params)
      replace path params designated with curley braces with a value
      void queryString​(java.lang.String name, java.lang.Object value)
      Add a query param
      void queryString​(java.lang.String name, java.util.Collection<?> value)
      Add a query param.
      void queryString​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Add query params as a map of key/values
      java.lang.String rawPath()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • url

        private java.lang.String url

      • rawPath

        private java.lang.String rawPath

    • Constructor Detail

      • Path

        public Path​(java.lang.String url)
        construct a path
        Parameters:
        url - the URL

      • Path

        Path​(java.lang.String url,
     java.lang.String defaultBasePath)
        Construct a path with a URL that could be relative and a default base for it
        Parameters:
        url - the url
        defaultBasePath - the default base

    • Method Detail

      • param

        public void param​(java.util.Map<java.lang.String,​java.lang.Object> params)
        replace path params designated with curley braces with a value
        Parameters:
        params - a map of param names and values

      • param

        public void param​(java.lang.String name,
                  java.lang.String value)
        replace a single path param by name
        Parameters:
        name - the name of the path param
        value - the value to replace it with

      • encodePath

        private java.lang.String encodePath​(java.lang.String value)

      • queryString

        public void queryString​(java.lang.String name,
                        java.util.Collection<?> value)
        Add a query param. This will result in a query param per value
        Parameters:
        name - the name
        value - a collection of values

      • queryString

        public void queryString​(java.lang.String name,
                        java.lang.Object value)
        Add a query param
        Parameters:
        name - the name
        value - the value

      • queryString

        public void queryString​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Add query params as a map of key/values
        Parameters:
        parameters - the params to add

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • escape

        private java.lang.String escape​(java.lang.String string)

      • rawPath

        public java.lang.String rawPath()
        Returns:
        the full raw path

      • baseUrl

        public java.lang.String baseUrl()
        Returns:
        the URL without the query string

      • getQueryString

        public java.lang.String getQueryString()
        Returns:
        just the query string

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object