Package com.cheetahdigital.corekit.rest.params

Class BaseParams

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected static class  BaseParams.BaseBuilder<T extends BaseParams,​B extends BaseParams.BaseBuilder>
      Abstract builder class for creating subclasses of BaseParams

      • Nested classes/interfaces inherited from interface android.os.Parcelable

        android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static android.os.Parcelable.Creator<BaseParams> CREATOR  
      protected java.lang.String mId  
      protected java.util.Map<java.lang.String,​java.lang.Object> mQueryMap  

      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BaseParams()  
      protected BaseParams​(android.os.Parcel in)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addParam​(java.lang.String param, java.lang.Object value)
      Add a parameter to the existing query map.
      int describeContents()  
      java.lang.String getAccessToken()  
      java.lang.String getId()  
      <T> T getParam​(java.lang.String param)
      Returns the value from the query map using the param as key
      java.util.Map<java.lang.String,​java.lang.Object> getQueryMap()
      Returns the query map
      void setAccessToken​(java.lang.String accessToken)
      Set the access token used for current api call
      void setId​(java.lang.String id)
      Set the module id or module internal name
      void writeToParcel​(android.os.Parcel dest, int flags)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • mQueryMap

        protected java.util.Map<java.lang.String,​java.lang.Object> mQueryMap

      • mId

        protected java.lang.String mId

      • CREATOR

        public static final android.os.Parcelable.Creator<BaseParams> CREATOR

    • Constructor Detail

      • BaseParams

        protected BaseParams()

      • BaseParams

        protected BaseParams​(android.os.Parcel in)

    • Method Detail

      • describeContents

        public int describeContents()
        Specified by:
        describeContents in interface android.os.Parcelable

      • writeToParcel

        @CallSuper
public void writeToParcel​(android.os.Parcel dest,
                          int flags)
        Specified by:
        writeToParcel in interface android.os.Parcelable

      • addParam

        @CallSuper
public void addParam​(@NonNull
                     java.lang.String param,
                     @Nullable
                     java.lang.Object value)
        Add a parameter to the existing query map. If value is null, it will be removed from the query map
        Parameters:
        param - the parameter key
        value - parameter value

      • getParam

        @CallSuper
public <T> T getParam​(java.lang.String param)
        Returns the value from the query map using the param as key
        Type Parameters:
        T - expected type of the object
        Parameters:
        param - the key to be used for retrieving the value from the query map
        Returns:
        current object with type T stored in the map, else null

      • setId

        public void setId​(java.lang.String id)
        Set the module id or module internal name
        Parameters:
        id - the id or internal name of the module

      • getId

        public java.lang.String getId()
        Returns:
        the module id

      • setAccessToken

        public void setAccessToken​(@Nullable
                           java.lang.String accessToken)
        Set the access token used for current api call
        Parameters:
        accessToken - the access token to use for the call

      • getAccessToken

        @Nullable
public java.lang.String getAccessToken()
        Returns:
        access token of the current params

      • getQueryMap

        public java.util.Map<java.lang.String,​java.lang.Object> getQueryMap()
        Returns the query map
        Returns:
        the current query map