/*
 * (c) Copyright 2010-2011 AgileBirds
 *
 * This file is part of OpenFlexo.
 *
 * OpenFlexo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OpenFlexo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenFlexo. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package org.netbeans.lib.cvsclient.request;

import java.io.File;

/**
 * Tells the server that a particular filename has not been modified in the checked-out directory.
 * 
 * @author Robert Greig
 */
public class UnchangedRequest extends Request {
	/**
	 * The filename of the file that is unchanged
	 */
	private String filename;

	/**
	 * Construct an Unchanged request
	 * 
	 * @param theFilename
	 *            the unchanged file's name
	 */
	public UnchangedRequest(String theFilename) {
		filename = theFilename;
	}

	/**
	 * Construct an Unchanged request
	 * 
	 * @param file
	 *            the unchanged file
	 */
	public UnchangedRequest(File file) {
		filename = file.getName();
	}

	/**
	 * Get the request String that will be passed to the server
	 * 
	 * @return the request String
	 * @throws UnconfiguredRequestException
	 *             if the request has not been properly configured
	 */
	@Override
	public String getRequestString() throws UnconfiguredRequestException {
		if (filename == null) {
			throw new UnconfiguredRequestException("Filename must be set");
		}
		return "Unchanged " + filename + "\n"; // NOI18N
	}

	/**
	 * Is a response expected from the server?
	 * 
	 * @return true if a response is expected, false if no response if expected
	 */
	@Override
	public boolean isResponseExpected() {
		return false;
	}
}