com.gwtplatform.mvp.client.proxy.AsyncCallFailEvent Maven / Gradle / Ivy
/**
* Copyright 2011 ArcBees Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.gwtplatform.mvp.client.proxy;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HasHandlers;
import com.google.web.bindery.event.shared.EventBus;
/**
* Event fired after any asynchronous call to the server performed by GWTP MVP returns with
* Such asynchronous calls only occur when using code splitting.
*
* @author Philippe Beaudoin
* @see AsyncCallFailHandler
* @see AsyncCallStartEvent
* @see AsyncCallSucceedEvent
*/
public class AsyncCallFailEvent extends GwtEvent {
private static final Type TYPE = new Type();
/**
* Fires a {@link AsyncCallFailEvent}
* into a source that has access to an {@link com.google.web.bindery.event.shared.EventBus}.
*
* @param source The source that fires this event ({@link EventBus}).
* @param caught failure encountered while executing a remote procedure call.
*/
public static void fire(EventBus source, Throwable caught) {
source.fireEvent(new AsyncCallFailEvent(caught));
}
/**
* Fires a {@link AsyncCallFailEvent}
* into a source that has access to an {@link com.google.web.bindery.event.shared.EventBus}.
*
* @param source The source that fires this event ({@link HasHandlers}).
* @param caught failure encountered while executing a remote procedure call.
* @deprecated Use {@link #fire(EventBus, Throwable)} instead.
*/
@Deprecated
public static void fire(final HasHandlers source, Throwable caught) {
source.fireEvent(new AsyncCallFailEvent(caught));
}
private final Throwable caught;
/**
* Creates an event indicating that an asynchronous call has failed, and attach a {@link Throwable}
* to it.
*
* @param caught failure encountered while executing a remote procedure call.
*/
AsyncCallFailEvent(Throwable caught) {
this.caught = caught;
}
public static Type getType() {
return TYPE;
}
@Override
public Type getAssociatedType() {
return getType();
}
@Override
protected void dispatch(AsyncCallFailHandler handler) {
handler.onAsyncCallFail(this);
}
/**
* Access the {@link Throwable} that was obtained when this asynchronous call failed.
*
* @return The {@link PlaceRequest} or {@code null} if no place request is
* known.
*/
public Throwable getCaught() {
return caught;
}
}