rocks.xmpp.core.session.SessionStatusEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmpp-core-client
Core XMPP client logic
There is a newer version: 0.9.1
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Christian Schudt
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package rocks.xmpp.core.session;

import java.util.EventObject;
import java.util.function.Consumer;

/**
 * An XMPP session event is fired, whenever the status of a session has changed, e.g. when it is abnormally disconnected.
 *
 * @author Christian Schudt
 * @see XmppSession#addSessionStatusListener(Consumer)
 */
public final class SessionStatusEvent extends EventObject {
    private final Throwable throwable;

    private final XmppSession.Status status;

    private final XmppSession.Status oldStatus;

    /**
     * Constructs a session status event.
     *
     * @param source    The object on which the event initially occurred.
     * @param status    The session status.
     * @param throwable An optional throwable.
     * @throws IllegalArgumentException if source is null.
     */
    SessionStatusEvent(XmppSession source, XmppSession.Status status, XmppSession.Status oldStatus, Throwable throwable) {
        super(source);
        this.throwable = throwable;
        this.status = status;
        this.oldStatus = oldStatus;
    }

    /**
     * Gets the session status.
     *
     * @return The session status.
     */
    public final XmppSession.Status getStatus() {
        return status;
    }

    /**
     * Gets the throwable if the session abnormally disconnected or null.
     *
     * @return The throwable, which caused a disconnection or null.
     */
    public final Throwable getThrowable() {
        return throwable;
    }

    /**
     * Gets the old session status.
     *
     * @return The old session status.
     */
    public final XmppSession.Status getOldStatus() {
        return oldStatus;
    }

    @Override
    public final String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(status).append(" (old status: ")
                .append(oldStatus)
                .append(')');
        if (throwable != null) {
            sb.append("\nStatus change caused by:\n")
                    .append(throwable);
        }
        return sb.toString();
    }
}