org.eclipse.jface.bindings.Trigger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotless-ext-greclipse Show documentation

Groovy Eclipse's formatter bundled for Spotless

The newest version!

/*******************************************************************************
 * Copyright (c) 2004, 2013 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.bindings;

/**
 * 
 * The abstract class for any object that can be used as a trigger for a binding. 
 * This ensures that trigger conform to certain minimum requirements. Namely, triggers 
 * need to be hashable.
 * 
 * 
 * @since 3.1
 */
public abstract class Trigger implements Comparable {

    /**
     * Tests whether this object is equal to another object. A handle object is
     * only equal to another trigger with the same properties.
     * 
     * @param object
     *            The object with which to compare; may be null.
     * @return true if the objects are equal; false
     *         otherwise.
     */
    @Override
	public abstract boolean equals(final Object object);

    /**
     * Computes the hash code for this object.
     * 
     * @return The hash code for this object.
     */
    @Override
	public abstract int hashCode();
}