ArgumentRequest.java

/*****************************************************************************
 * Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License Version
 * 1.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is available at http://www.sun.com/
 *
 * The Original Code is the CVS Client Library.
 * The Initial Developer of the Original Code is Robert Greig.
 * Portions created by Robert Greig are Copyright (C) 2000.
 * All Rights Reserved.
 *
 * Contributor(s): Robert Greig.
 *****************************************************************************/
package org.netbeans.lib.cvsclient.request;

import org.netbeans.lib.cvsclient.util.BugLog;

/**
 * The Argument request. The server saves the specified argument for use in
 * a future argument-using command
 * @author  Robert Greig
 */
public final class ArgumentRequest extends AbstractRequest {

	// Fields =================================================================

	private final String argument;

	// Setup ==================================================================

	/**
	 * Create a new request
	 * @param argument the argument to use
	 */
	public ArgumentRequest(String argument) {
		BugLog.getInstance().assertNotNull(argument);

		this.argument = argument;
	}

	// Implemented ============================================================

	/**
	 * Get the request String that will be passed to the server
	 * @return the request String
	 */
	public String getRequestString() {
		return "Argument " + argument + "\n";
	}
}