Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.common;
020
021import org.apache.reef.io.naming.Identifiable;
022import org.apache.reef.util.Optional;
023
024/**
025 * Common interface for all error messages in REEF.
026 * Most of its functionality is generic and implemented in the AbstractFailure class.
027 */
028public interface Failure extends Identifiable {
029
030  /**
031   * @return One-line error message. Should never be null.
032   */
033  String getMessage();
034
035  /**
036   * @return Optional long error description.
037   */
038  Optional<String> getDescription();
039
040  /**
041   * @return Java Exception that caused the error, if any.
042   */
043  Optional<Throwable> getReason();
044
045
046  /**
047   * @return Optional serialized version of the error message.
048   */
049  Optional<byte[]> getData();
050
051  /**
052   * Return the original Java Exception, or generate a new one if it does not exists.
053   * ALWAYS returns an exception.
054   *
055   * @return A java exception. Never null.
056   */
057  Throwable asError();
058}