com.lajospolya.spotifyapiwrapper.request.AbstractBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotify-api-wrapper Show documentation

This project wraps the Spotify public API in order to allow users to intuitively use it

There is a newer version: 3.0.RELEASE

package com.lajospolya.spotifyapiwrapper.request;

import com.lajospolya.spotifyapiwrapper.request.service.ISpotifyRequestParamValidationService;
import com.lajospolya.spotifyapiwrapper.request.service.SpotifyRequestParamValidationService;

/**
 * This is the base class for all Request Builders
 * @author Lajos Polya
 * @param  The type of the request it buils
 */
public abstract class AbstractBuilder
{
    static final String IDS_QUERY_PARAM = "ids";
    static final String MARKET_QUERY_PARAM = "market";
    static final String COUNTRY_QUERY_PARAM = "country";
    static final String LOCALE_QUERY_PARAM = "locale";
    static final String LIMIT_QUERY_PARAM = "limit";
    static final String OFFSET_QUERY_PARAM = "offset";
    static final String TIMESTAMP_QUERY_PARAM = "timestamp";
    static final String TYPE_QUERY_PARAM = "type";
    static final String AFTER_QUERY_PARAM = "after";
    static final String BEFORE_QUERY_PARAM = "before";
    static final String FIELDS_QUERY_PARAM = "fields";
    static final String URI_QUERY_PARAM = "uri";
    static final String STATE_QUERY_PARAM = "state";
    static final String VOLUME_PERCENT_QUERY_PARAM = "volume_percent";
    static final String POSITION_MS_QUERY_PARAM = "position_ms";
    static final String DEVICE_ID_QUERY_PARAM = "device_id";
    static final String TIME_RANGE_QUERY_PARAM = "time_range";
    static final String SEED_ARTISTS_QUERY_PARAM = "seed_artists";
    static final String SEED_TRACKS_QUERY_PARAM = "seed_tracks";
    static final String SEED_GENRES_QUERY_PARAM = "seed_genres";
    static final String INCLUDE_GROUPS_QUERY_PARAM = "include_groups";
    static final String MIN_PARAM_PREFIX = "min_";
    static final String MAX_PARAM_PREFIX = "max_";
    static final String TARGET_PARAM_PREFIX = "target_";

    static final String APPLICATION_JSON_CONTENT_TYPE_HEADER_VALUE = "application/json";
    static final String URL_ENCODED_CONTENT_TYPE_HEADER_VALUE = "application/x-www-form-urlencoded";
    static final String IMAGE_JPEG_HEADER_VALUE = "image/jpeg";

    static final String CLIENT_CREDENTIALS_GRANT_TYPE_BODY_PARAMS = "grant_type=client_credentials";

    static final String QUERY = "q";
    static final String INCLUDE_EXTERNAL = "include_external";

    ISpotifyRequestParamValidationService spotifyRequestParamValidationService;

    AbstractBuilder()
    {
        spotifyRequestParamValidationService = new SpotifyRequestParamValidationService();
    }

    /**
     * Build the Spotify Request with all appropriate headers, params, body, etc
     * @return the built Spotify Request
     */
    abstract public T build();
}