KeyBinding.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff.
 * Copyright (C) 2006-2011 Andreas Kirschbaum.
 */

package com.realtime.crossfire.jxclient.gui.keybindings;

import com.realtime.crossfire.jxclient.gui.commandlist.CommandList;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public abstract class KeyBinding {

    @NotNull
    private final CommandList commands;

    private final boolean isDefault;

    @NotNull
    public CommandList getCommands() {
        return commands;
    }

    protected KeyBinding(@NotNull final CommandList commands, final boolean isDefault) {
        this.commands = commands;
        this.isDefault = isDefault;
    }

    @Override
    public abstract boolean equals(@Nullable final Object obj);

    @Override
    public abstract int hashCode();

    public abstract boolean matchesKeyCode(@NotNull final KeyEvent2 keyEvent);

    public abstract boolean matchesKeyChar(final char keyChar);

    @NotNull
    public abstract String getBindingDescription();

    @NotNull
    public String getCommandString() {
        return commands.getCommandString();
    }

    public boolean isDefault() {
        return isDefault;
    }

}