Class MenuShortcut

public MenuShortcut(int key)

Initializes a new instance of MenuShortcut with the specified virtual key value.

Parameters:

key - The virtual keycode for the shortcut.

public MenuShortcut(int key,
                    boolean usesShift)

Initializes a new instance of MenuShortcut with the specified virtual key value and shift setting.

Parameters:

key - The virtual keycode for the shortcut.

usesShift - true if the shift key was pressed, false otherwise.

public boolean equals(MenuShortcut obj)

Tests this object for equality against the specified object. The two objects will be considered equal if and only if the specified object is an instance of MenuShortcut and has the same key value and shift setting as this object.

Parameters:

obj - The object to test for equality against.

Returns:

true if the two objects are equal, false otherwise.

public boolean equals(Object obj)

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:

equals in interface Object

Parameters:

obj - the Object to compare to

Returns:

whether this Object is semantically equal to another

See Also:

Object.hashCode()

public int getKey()

Returns the virtual keycode for this shortcut.

Returns:

The virtual keycode for this shortcut.

public int hashCode()

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:

hashCode in interface Object

Returns:

the hash code for this Object

See Also:

Object.equals(Object), System.identityHashCode(Object)

protected String paramString()

Returns a debugging string for this object.

Returns:

A debugging string for this object.

public String toString()

Returns a string representation of this shortcut.

Overrides:

toString in interface Object

Returns:

A string representation of this shortcut.

public boolean usesShiftModifier()

Returns the shift setting for this shortcut.

Returns:

true if the shift key was pressed, false otherwise.