io.guise.framework.input.KeystrokeInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.guise.framework.input;

import static java.util.Objects.*;

import com.globalmentor.java.Objects;

/**
 * An encapsulation of key stroke input.
 * @author Garret Wilson
 */
public class KeystrokeInput extends AbstractGestureInput implements KeyboardInput {

	/** The key that was pressed. */
	private final Key key;

	/** @return The key that was pressed. */
	public Key getKey() {
		return key;
	}

	/**
	 * Key and keys constructor.
	 * @param key The key that was pressed.
	 * @param keys The keys that were pressed when this input occurred.
	 * @throws NullPointerException if the given key and/or keys is null.
	 */
	public KeystrokeInput(final Key key, final Key... keys) {
		super(keys); //construct the parent class
		this.key = requireNonNull(key, "Key cannot be null."); //save the key
	}

	/**
	 * {@inheritDoc}
	 * 
	 * This version extends the hash code of the underlying objects with the the key.
	 * 
	 */
	@Override
	public int hashCode() {
		return Objects.getHashCode(super.hashCode(), key); //extend the hash code with the key
	}

	/**
	 * {@inheritDoc}
	 * 
	 * Besides the default checks, this version ensures that the keys are equal.
	 * 
	 */
	@Override
	public boolean equals(final Object object) {
		return super.equals(object) && getKey() == ((KeystrokeInput)object).getKey(); //if the default checks pass, the object is of the correct type; compare keys
	}

	@Override
	public String toString() {
		return getKey().toString() + ' ' + super.toString(); //add the key representation to the string
	}
}