hu.icellmobilsoft.coffee.dto.exception.BaseExceptionWrapper Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.dto.exception;

/**
 * Nem céges kivételek, amik nem a BaseException-bol öröklődnek, ezen az interfészen keresztül tudnak kapcsolódni a céges kivételkezelő rendszerhez.
 *
 * Az interfész célja, hogy a céges kivételeket be lehessen burkolni olyan alacsony szintű JAX-RS metódusokban, amik kötött dobási szabályal
 * rendelkeznek.
 *
 * Példa:
 *
 *  * 
 * public class SpecialProcessingException extends ProcessingException implements BaseExceptionWrapper<MyException> {
 *     private MyException baseException;
 *
 *     @Override
 *     public void setBaseException(final MyException baseException) {
 *         this.baseException = baseException;
 *     }
 *
 *     @Override
 *     public MyException getBaseException() {
 *         return getBaseException();
 *     }
 * }
 * 
 * 
 * 
 *  * 
 * @Override
 * public BasicRequestType readFrom(Class<BasicRequestType> type, Type genericType, Annotation[] annotations, MediaType mediaType,
 *         MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException {
 *
 *     BasicRequestType result = null;
 *     try {
 *         // ...
 *     } catch (MyException e) {
 *         throw new SpecialProcessingException(e.getMessage(), e);
 *     }
 *     return result;
 * }
 * 
 * 
 *
 * @param 
 *            Kivétel osztály, ami a keretrendszer BaseException osztályából származik.
 * @author attila.gluck
 * @author attila.nyers
 * @author ferenc.lutischan
 * @since 1.0.0
 */
public interface BaseExceptionWrapper {
    /**
     * setException.
     * 
     * @param exception
     *            exception
     */
    void setException(final E exception);

    /**
     * getException.
     * 
     * @return E
     */
    E getException();
}