paramnotpresentexception.java

Vodafone betavine java api source code, the latest snapshot.

package com.bv.api;
import java.util.Vector;

/**
 * Thrown when a required parameter is not present
 * @author C. Oattes
 */
public class ParamNotPresentException extends Exception {

	private Vector<String> params = null;
	private String error = "The following required parameters were not set: ";
	
	/**
	 * Create a ParamNotPresentException with the parameters stored in params
	 * @param params A list of the parameters that have not been specified.
	 */
	public ParamNotPresentException(Vector<String> params) {
		super();
		this.params = params;
		for (String param : params) {
			error += param + " ";
		}
		error = error.trim();
	}
	
	/**
	 * Get the error message
	 * @return A space separated list of parameters that have not been specified.
	 */
	public String getError() {
		return error;
	}

	/**
	 * Get the list of parameters not set
	 * @return A Vector which contains a list of String parameters that have not been set.
	 */
	public Vector<String> getParams() {
		return params;
	}
}