com.twitter.common.base.ExceptionalCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of base Show documentation

Common base library.

The newest version!

// =================================================================================================
// Copyright 2011 Twitter, Inc.
// -------------------------------------------------------------------------------------------------
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this work except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file, or 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.twitter.common.base;

/**
 * An interface that captures a unit of work.
 *
 * @param  The type of exception that the command throws.
 *
 * @author John Sirois
 */
public interface ExceptionalCommand {

  /**
   * Performs a unit of work, possibly throwing {@code E} in the process.
   *
   * @throws E if there was a problem performing the work
   */
  void execute() throws E;
}