net.fckeditor.handlers.Command Maven / Gradle / Ivy

Go to download
/*
 * FCKeditor - The text editor for Internet - http://www.fckeditor.net
 * Copyright (C) 2004-2009 Frederico Caldeira Knabben
 * 
 * == BEGIN LICENSE ==
 * 
 * Licensed under the terms of any of the following licenses at your
 * choice:
 * 
 *  - GNU General Public License Version 2 or later (the "GPL")
 *    http://www.gnu.org/licenses/gpl.html
 * 
 *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")
 *    http://www.gnu.org/licenses/lgpl.html
 * 
 *  - Mozilla Public License Version 1.1 or later (the "MPL")
 *    http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * == END LICENSE ==
 */
package net.fckeditor.handlers;

import java.util.HashMap;
import java.util.Map;

import net.fckeditor.tool.Utils;

/**
 * File Browser GET and POST commands.

 * The File Browser sends a specific command for each and every request. This
 * class is intended to reflect these in an Enum-like manner.
 * 
 * The commands are for GET:
 * 

 * GetFolders
 * GetFoldersAndFiles
 * CreateFolder
 * 
 * and for POST:
 * 
 * FileUpload
 * QuickUpload
 *
 * 
 * @version $Id: Command.java 3759 2009-06-22 20:02:26Z mosipov $
 */
public class Command {

	private String name;
	private static final Map getCommands = new HashMap(
			3);
	private static final Map postCommands = new HashMap(
			2);
	/** GET command GetFolders */
	public static final Command GET_FOLDERS = new Command("GetFolders");
	/** GET command GetFoldersAndFiles */
	public static final Command GET_FOLDERS_AND_FILES = new Command(
			"GetFoldersAndFiles");
	/** GET command CreateFolder */
	public static final Command CREATE_FOLDER = new Command("CreateFolder");
	/** POST command FileUpload */
	public static final Command FILE_UPLOAD = new Command("FileUpload");
	/** POST command QuickUpload */
	public static final Command QUICK_UPLOAD = new Command("QuickUpload");

	static {
		// initialize the get commands
		getCommands.put(GET_FOLDERS.getName(), GET_FOLDERS);
		getCommands.put(GET_FOLDERS_AND_FILES.getName(), GET_FOLDERS_AND_FILES);
		getCommands.put(CREATE_FOLDER.getName(), CREATE_FOLDER);

		// initialize the post commands
		postCommands.put(FILE_UPLOAD.getName(), FILE_UPLOAD);
		postCommands.put(QUICK_UPLOAD.getName(), QUICK_UPLOAD);
	}

	/**
	 * Constructs a command with the given name.
	 * 
	 * @param name
	 *            the name of the new command
	 */
	private Command(final String name) {
		this.name = name;
	}

	/**
	 * Returns the name of this command.
	 * 
	 * @return the name of this command
	 */
	public String getName() {
		return name;
	}

	/**
	 * Returns the command constant with the specified name.
	 * 
	 * @param name
	 *            the name of the constant to return
	 * @return  the command constant with the specified name
	 * @throws IllegalArgumentException
	 *              if this class has no constant with the specified name
	 * @throws NullPointerException
	 *             if name is null or empty
	 */
	public static Command valueOf(final String name) {
		if (Utils.isEmpty(name))
			throw new NullPointerException("Name is null or empty");

		Command command = getCommands.get(name);
		if (command == null)
			command = postCommands.get(name);
		if (command == null)
			throw new IllegalArgumentException("No command const " + name);

		return command;
	}

	/**
	 * Returns true if name represents a valid GET
	 * command constant.
	 * 
	 * @param name
	 *            the command to check
	 * @return true if name represents a valid command, else
	 *         false
	 */
	public static boolean isValidForGet(final String name) {
		return getCommands.containsKey(name);
	}

	/**
	 * Returns true if name represents a valid POST
	 * command constant.
	 * 
	 * @param name
	 *            the command to check
	 * @return true if name represents a valid command, else
	 *         false
	 */
	public static boolean isValidForPost(final String name) {
		return postCommands.containsKey(name);
	}

	/**
	 * Returns the command constant with the specified name. In contrast to
	 * {@link #valueOf(String)} it returns a null instead of throwing an
	 * exception if a command constant was not found.
	 * 
	 * @param name
	 *            the name of the constant to return
	 * @return the command constant with the specified name, else
	 *         null
	 */
	public static Command getCommand(final String name) {
		try {
			return Command.valueOf(name);
		} catch (Exception e) {
			return null;
		}
	}
	
	/**
	 * Compares the specified object with this command for equality. The
	 * comparison is based on class and name only.
	 * 
	 * @param obj
	 *            Object to be compared with this command.
	 * @return true if the specified object is equal to this
	 *         command
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;

		if (obj == null || this.getClass() != obj.getClass())
			return false;

		final Command command = (Command) obj;
		return name.equals(command.getName());
	}

	/**
	 * Returns the hash code value for this command. The hash code equals the
	 * hash code of the name field.
	 * 
	 * @return the hash code value for this command
	 */
	@Override
	public int hashCode() {
		return name.hashCode();
	}

	/**
	 * Returns a string representation of this command.
	 * 
	 * @return a string representation of this command
	 * @see #getName()
	 */
	@Override
	public String toString() {
		return name;
	}
}