LifecycleCallback.java

/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.jboss.errai.ioc.client.lifecycle.api;

/**
 * A callback used by callers of
 * {@link LifecycleEvent#fireAsync(LifecycleCallback)}.
 * 
 * @author Max Barkley <mbarkley@redhat.com>
 */
public interface LifecycleCallback {

  /**
   * A callback used to get the result of a fired {@link LifecycleEvent}.
   * 
   * @param success
   *          True iff all {@link LifecycleListener LifecycleListeners} for this
   *          event did not {@linkplain LifecycleEvent#veto() veto}.
   */
  public void callback(boolean success);

}