bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/internal/commands/keys/KeyStroke.java

/************************************************************************
Copyright (c) 2002 IBM Corporation and others.
All rights reserved.   This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/cpl-v10.html

Contributors:
	IBM - Initial implementation
************************************************************************/

package org.eclipse.ui.internal.commands.keys;

import org.eclipse.ui.IMemento;

public final class KeyStroke implements Comparable {

	public final static String ELEMENT = "keystroke"; //$NON-NLS-1$
	private final static String ATTRIBUTE_ACCELERATOR = "accelerator"; //$NON-NLS-1$

	public static KeyStroke create(int accelerator) {
		return new KeyStroke(accelerator);
	}

	public static KeyStroke[] create(int[] accelerators)
		throws IllegalArgumentException {
		if (accelerators == null)
			throw new IllegalArgumentException();
					
		KeyStroke[] keyStrokes = new KeyStroke[accelerators.length];
			
		for (int i = 0; i < accelerators.length; i++)
			keyStrokes[i] = create(accelerators[i]);
		
		return keyStrokes;			
	}

	public static KeyStroke read(IMemento memento)
		throws IllegalArgumentException {
		if (memento == null)
			throw new IllegalArgumentException();

		Integer accelerator = memento.getInteger(ATTRIBUTE_ACCELERATOR);
		
		if (accelerator == null)
			throw new IllegalArgumentException();
		
		return KeyStroke.create(accelerator.intValue());
	}

	private int accelerator;

	private KeyStroke(int accelerator) {
		super();
		this.accelerator = accelerator;
	}

	public int getAccelerator() {
		return accelerator;
	}

	public void write(IMemento memento)
		throws IllegalArgumentException {
		if (memento == null)
			throw new IllegalArgumentException();
			
		memento.putInteger(ATTRIBUTE_ACCELERATOR, accelerator);
	}
	
	public int compareTo(Object object) {
		return accelerator - ((KeyStroke) object).accelerator;
	}
	
	public boolean equals(Object object) {
		return object instanceof KeyStroke && accelerator == ((KeyStroke) object).accelerator;	
	}

	public int hashCode() {
		return accelerator;	
	}
}