GuiStateManager.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-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.guistate;
 
import com.realtime.crossfire.jxclient.util.EventListenerList2;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public abstract class GuiStateManager {
 
    @Nullable
    private GuiState guiState;
 
    @NotNull
    private final Object sync = new Object();
 
    @NotNull
    private final EventListenerList2<GuiStateListener> guiStateListeners = new EventListenerList2<>();
 
    protected GuiStateManager() {
    }
 
    public void changeGUI(@NotNull final GuiState guiState) {
        synchronized (sync) {
            if (this.guiState == guiState) {
                return;
            }
 
            this.guiState = guiState;
        }
 
        doChangeGUI(() -> {
            switch (guiState) {
            case START:
                for (GuiStateListener listener : guiStateListeners) {
                    listener.start();
                }
                break;
 
            case METASERVER:
                for (GuiStateListener listener : guiStateListeners) {
                    listener.metaserver();
                }
                break;
 
            case CONNECTING:
                throw new IllegalArgumentException("changeGUI() called in state CONNECTING");
 
            case CONNECTED:
                for (GuiStateListener listener : guiStateListeners) {
                    listener.connected();
                }
                break;
 
            case CONNECT_FAILED:
                throw new IllegalArgumentException("changeGUI() called in state CONNECT_FAILED");
            }
        });
    }
 
    protected abstract void doChangeGUI(@NotNull final Runnable runnable);
 
    private void changeGUI(@NotNull final GuiState guiState, @NotNull final String param) {
        synchronized (sync) {
            if (this.guiState == guiState) {
                return;
            }
 
            this.guiState = guiState;
 
            switch (guiState) {
            case START:
                throw new IllegalArgumentException("changeGUI() called in state START");
 
            case METASERVER:
                throw new IllegalArgumentException("changeGUI() called in state METASERVER");
 
            case CONNECTING:
                for (GuiStateListener listener : guiStateListeners) {
                    listener.preConnecting(param);
                }
                for (GuiStateListener listener : guiStateListeners) {
                    listener.connecting(param);
                }
                break;
 
            case CONNECTED:
                throw new IllegalArgumentException("changeGUI() called in state CONNECTED");
 
            case CONNECT_FAILED:
                for (GuiStateListener listener : guiStateListeners) {
                    listener.connectFailed(param);
                }
                break;
            }
        }
    }
 
    @Nullable
    public GuiState getGuiState() {
        synchronized (sync) {
            return guiState;
        }
    }
 
    public void addGuiStateListener(@NotNull final GuiStateListener listener) {
        guiStateListeners.add(listener);
    }
 
    public void removeGuiStateListener(@NotNull final GuiStateListener listener) {
        guiStateListeners.remove(listener);
    }
 
    public void connect(@NotNull final String serverInfo) {
        changeGUI(GuiState.CONNECTING, serverInfo);
    }
 
    public void disconnect() {
        changeGUI(GuiState.METASERVER);
    }
 
    public void setClientSocketState(@NotNull final ClientSocketState clientSocketState, @NotNull final String param) {
        for (GuiStateListener listener : guiStateListeners) {
            listener.connecting(clientSocketState, param);
        }
        if (clientSocketState == ClientSocketState.CONNECTED) {
            changeGUI(GuiState.CONNECTED);
        }
    }
 
    public void disconnecting(@NotNull final String reason, final boolean isError) {
        synchronized (sync) {
            if (guiState == GuiState.CONNECTING || (isError && guiState == GuiState.CONNECTED)) {
                changeGUI(GuiState.CONNECT_FAILED, reason);
            }
        }
    }
 
    public void disconnected() {
        synchronized (sync) {
            if (guiState != GuiState.CONNECT_FAILED) {
                changeGUI(GuiState.METASERVER);
            }
        }
    }
 
}