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.runtime.common.utils;
020
021import org.apache.reef.tang.annotations.DefaultImplementation;
022import org.apache.reef.util.Optional;
023
024/**
025 * (De-)serializes exceptions.
026 */
027@DefaultImplementation(DefaultExceptionCodec.class)
028public interface ExceptionCodec {
029
030  /**
031   * Deserializes a Throwable that has been serialized using toBytes().
032   *
033   * @param bytes
034   * @return the Throwable or Optional.empty() if the deserialization fails.
035   */
036  Optional<Throwable> fromBytes(final byte[] bytes);
037
038  /**
039   * @param bytes
040   * @return fromBytes(bytes.get()) or Optional.empty()
041   */
042  Optional<Throwable> fromBytes(final Optional<byte[]> bytes);
043
044  /**
045   * @param throwable
046   * @return the serialized form of the given Throwable.
047   */
048  byte[] toBytes(final Throwable throwable);
049
050}