Modulo.java

/*
 * JSwiff is an open source Java API for Macromedia Flash file generation
 * and manipulation
 *
 * Copyright (C) 2004-2005 Ralf Terdic (contact@jswiff.com)
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package com.jswiff.swfrecords.actions;

/**
 * <p>
 * Calculates the remainder of the division between two numbers.
 * </p>
 * 
 * <p>
 * Performed stack operations:<br>
 * <code>pop b</code><br>
 * <code>pop a</code><br>
 * <code>push [a % b]</code> (remainder of division between a and b)<br>
 * </p>
 * 
 * <p>
 * ActionScript equivalent: <code>%</code> operator
 * </p>
 * 
 * @since SWF 4
 */
public final class Modulo extends Action implements ActionSign {
	/**
	 * Creates a new Modulo action.
	 */
	public Modulo() {
		code = ActionConstants.MODULO;
	}

	/**
	 * Returns a short description of this action.
	 * 
	 * @return <code>"Modulo"</code>
	 */
	public String toString() {
		return "Modulo";
	}

	public String getSign() {
		// TODO Auto-generated method stub
		return "%";
	}
}