org.apache.hadoop.util.functional.CallableRaisingIOE Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hadoop-common Show documentation

Apache Hadoop Common

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.hadoop.util.functional;

import java.io.IOException;
import java.io.UncheckedIOException;

/**
 * This is a callable which only raises an IOException.
 * Its method {@link #unchecked()} invokes the {@link #apply()}
 * method and wraps all IOEs in UncheckedIOException;
 * call this if you need to pass this through java streaming
 * APIs
 * @param  return type
 */
@FunctionalInterface
public interface CallableRaisingIOE {

  /**
   * Apply the operation.
   * @return result
   * @throws IOException Any IO failure
   */
  R apply() throws IOException;

  /**
   * Apply unchecked.
   * @return the evaluated call
   * @throws UncheckedIOException IOE raised.
   */
  default R unchecked() {
    try {
      return apply();
    } catch (IOException e) {
      throw new UncheckedIOException(e);
    }
  }

}