com.lukaspradel.steamapi.webapi.request.SteamWebApiRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of steam-web-api Show documentation

A library to provide access to the data available from Valve's Steam API

There is a newer version: 1.9.0

package com.lukaspradel.steamapi.webapi.request;

import java.util.Collections;
import java.util.Map;

import com.lukaspradel.steamapi.core.SteamApiRequest;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiInterface;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiInterfaceMethod;
import com.lukaspradel.steamapi.webapi.core.SteamWebApiVersion;

/**
 * Encapsulates a request to the Steam Web API with all its required and
 * optional properties.
 *
 * @author lpradel
 *
 */
public class SteamWebApiRequest extends SteamApiRequest {

	static final String WEB_API_BASE_URL = "api.steampowered.com";

	private final SteamWebApiInterface apiInterface;

	private final SteamWebApiInterfaceMethod interfaceMethod;

	private final SteamWebApiVersion version;

	protected SteamWebApiRequest(SteamWebApiRequestBuilder builder) {

		super(WEB_API_BASE_URL, builder.getParameters());

		this.apiInterface = builder.getInterface();
		this.interfaceMethod = builder.getInterfaceMethod();
		this.version = builder.getVersion();
	}

	public SteamWebApiInterface getApiInterface() {
		return apiInterface;
	}

	public SteamWebApiInterfaceMethod getInterfaceMethod() {
		return interfaceMethod;
	}

	public SteamWebApiVersion getVersion() {
		return version;
	}

	public Class getResponseType() {

		return interfaceMethod.getReponseType();
	}

	/**
	 * Generic builder class to create instances of {@link SteamWebApiRequest}.
	 * Consider using subclasses of this to create concrete requests for
	 * covenience.
	 *
	 * @author lpradel
	 *
	 */
	public static class SteamWebApiRequestBuilder {

		private final SteamWebApiInterface apiInterface;

		private final SteamWebApiInterfaceMethod interfaceMethod;

		private final SteamWebApiVersion version;

		private final Map parameters;

		protected SteamWebApiRequestBuilder() {

			apiInterface = null;
			interfaceMethod = null;
			version = null;
			parameters = null;
		}

		protected SteamWebApiRequestBuilder(SteamWebApiInterface apiInterface,
				SteamWebApiInterfaceMethod interfaceMethod,
				SteamWebApiVersion version, Map parameters) {

			this.apiInterface = apiInterface;
			this.interfaceMethod = interfaceMethod;
			this.version = version;
			this.parameters = parameters;
		}

		protected SteamWebApiInterface getInterface() {

			return apiInterface;
		}

		protected SteamWebApiInterfaceMethod getInterfaceMethod() {

			return interfaceMethod;
		}

		protected SteamWebApiVersion getVersion() {

			return version;
		}

		protected Map getParameters() {

			return Collections.unmodifiableMap(parameters);
		}

		public SteamWebApiRequest build() {

			return new SteamWebApiRequest(this);
		}
	}
}