Interface QueryParameterBasedRequest

All Known Subinterfaces:
BodyBasedRequest
All Known Implementing Classes:
AddInventoryRequest, AddOrderMessageRequest, AddReleaseToWantListRequest, AddToFolderRequest, ChangeInventoryRequest, ChangeReleaseRatingRequest, CreateFolderRequest, CreateListingRequest, DeleteFolderRequest, DeleteInstanceRequest, DeleteInventoryRequest, DeleteListingRequest, DeleteReleaseFormWantListRequest, DeleteUserReleaseRequest, DownloadInventoryExportRequest, EditInstanceFieldRequest, EditUserProfileRequest, GetArtistInformationRequest, GetArtistReleasesRequest, GetCollectionItemsByFolderRequest, GetCollectionItemsByReleaseRequest, GetCollectionValueRequest, GetCommunityReleaseRatingRequest, GetCustomFieldsRequest, GetExportRequest, GetExportsRequest, GetFeeRequest, GetFolderRequest, GetFoldersRequest, GetInventoryRequest, GetLabelInformationRequest, GetLabelReleasesRequest, GetListingRequest, GetMasterReleaseRequest, GetMasterReleaseVersionsRequest, GetOrderMessagesRequest, GetOrderRequest, GetOrdersRequest, GetPriceSuggestionsRequest, GetReleaseRequest, GetReleaseStatisticsRequest, GetUploadRequest, GetUploadsRequest, GetUserContributionsRequest, GetUserListRequest, GetUserListsRequest, GetUserProfileRequest, GetUserReleaseRatingRequest, GetUserSubmissionsRequest, GetWantListRequest, InventoryRequestBase, MoveReleaseRequest, PaginatedRequestBase, RenameFolderRequest, SearchRequest, UpdateListingRequest, UpdateOrderRequest, UpdateReleaseOnWantListRequest, UpdateUserReleaseRatingRequest
public interface QueryParameterBasedRequest
Defines a request that contain parameters to be constructed as query parameters in an HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    static okhttp3.HttpUrl.Builder
    appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder, String name, String value)
    Helper method to populate a query parameter if the string value is not blank.
    static okhttp3.HttpUrl.Builder
    appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder, String name, Object value)
    Helper method to populate a query parameter if the value is not null.
    okhttp3.HttpUrl.Builder
    populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)
    Helper method to populate query parameters of a HttpUrl.Builder.

  • Method Details

    • populateQueryParameters

      okhttp3.HttpUrl.Builder populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)
      Helper method to populate query parameters of a HttpUrl.Builder.
      Parameters:
      urlBuilder - the HttpUrl.Builder instance
      Returns:
      the HttpUrl.Builder instance

    • appendIfNotNull

      static okhttp3.HttpUrl.Builder appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder, String name, Object value)
      Helper method to populate a query parameter if the value is not null.
      Parameters:
      urlBuilder - the URL builder
      name - the query parameter name
      value - the query parameter value
      Returns:
      the builder

    • appendIfNotBlank

      static okhttp3.HttpUrl.Builder appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder, String name, String value)
      Helper method to populate a query parameter if the string value is not blank.
      Parameters:
      urlBuilder - the URL builder
      name - the query parameter name
      value - the query parameter value
      Returns:
      the builder