Laundry.java

/*
 * Copyright (C) 2011 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.bus.client.api.laundry;

/**
 * Represents a single cleanup task to be executed when a {@link LaundryList} is processed.
 * 
 * @author Mike Brock
 * @author Jonathan Fuerth <jfuerth@redhat.com>
 * @author Christian Sadilek <csadilek@redhat.com>
 */
public interface Laundry {

  /**
   * Performs whatever work is necessary in this cleanup item. Exceptions thrown from this method will be logged by the
   * framework, but will not otherwise have any effect on the cleanup process.
   * 
   * @see LaundryList#cleanAll()
   */
  public void clean() throws Exception;
}