juzu.UndeclaredIOException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of juzu-core

Where all the magic happens

There is a newer version: 1.2.0

/*
 * Copyright 2013 eXo Platform SAS
 *
 * 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.
 */

package juzu;

import java.io.IOException;
import java.lang.reflect.UndeclaredThrowableException;

/**
 * An unchecked wrapper for {@link IOException}. Note that this exception should not be abused, i.e it should not be
 * used in place of IOException. It should be used in the Juzu API used to develop an application, which
 * makes the IOException transparent to the developer, for instance we want to void the developer to care
 * about the IOException in this situation:
 * 
 * 

 *    public void index() throws IOException {
 *       template.render();
 *    }
 * 
 * 
 * Instead the {@link juzu.template.Template#render()} methods wraps the IOException with this unchecked
 * wrapper and the developer does not have to care about it anymore:
 * 

 * 

 *    public void index() {
 *       template.render();
 *    }
 * 
 *
 * @author Julien Viet
 */
public class UndeclaredIOException extends UndeclaredThrowableException {

  public UndeclaredIOException(IOException undeclaredIO) {
    super(undeclaredIO);
  }

  @Override
  public IOException getCause() {
    return (IOException)super.getCause();
  }
}