[jira] [Commented] (FLINK-5854) Introduce some Flink-specific base Exception types

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-5854?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15874852#comment-15874852 ] 

ASF GitHub Bot commented on FLINK-5854:
---------------------------------------

GitHub user StephanEwen opened a pull request:

    https://github.com/apache/flink/pull/3368

    [FLINK-5854] [core] Add base Flink Exception classes

    This pull request adds two exception base classes: `FlinkException` and `FlinkRuntimeException`.
    They are useful in improving the way certain parts of the code handle exceptions.
    
      - `FlinkException` is a base class for checked exceptions that indicate that something related to using Flink went wrong. It is helpful, because letting a method throw `FlinkException` rather than `Exception` already helps to not include all of Java's runtime exceptions, which indicate programming errors, rather than situations that should be recovered.
      - `FlinkRuntimeException` as a Flink-specific subclass of `RuntimeException` comes in handy in places where no exceptions were declared, for example when reusing an interface that does not declare exceptions.
    
    **Important: This does not mean we should just declare `FlinkException` everywhere and throw and catch `FlinkException` and `FlinkRuntimeException` arbitrarily. Exception handling remains a careful and conscious task.**
    
    This also adds the `DynamicCodeLoadingException` subclass of `FlinkException` as an example.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/StephanEwen/incubator-flink exceptions

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/3368.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #3368
    
----
commit 1bed2d20a5ccfae4ae7bdfadaaf03fcbe1dba449
Author: Stephan Ewen <se...@apache.org>
Date:   2017-02-17T15:24:35Z

    [FLINK-XXXX] [core] Add base Flink Exception classes

----


> Introduce some Flink-specific base Exception types
> --------------------------------------------------
>
>                 Key: FLINK-5854
>                 URL: https://issues.apache.org/jira/browse/FLINK-5854
>             Project: Flink
>          Issue Type: Improvement
>          Components: Core
>            Reporter: Stephan Ewen
>            Assignee: Stephan Ewen
>             Fix For: 1.3.0
>
>
> Going through the code, there are a lot of places where exception handling could be done a bit nicer, for example 
>   - Some methods do not declare exceptions at all in their signatures. They simply catch all and wrap it in a {{RuntimeException}}.
>   - Some places declare overly generic that they throw {{Exception}}, even though they could very specifically type the exceptions they throw.
> I suggest to introduce two new basic exceptions, that at least help document a bit more what goes wrong:
>   - {{FlinkException}} as a base class for checked exceptions that indicate that something related to using Flink went wrong. Letting a method throw {{FlinkException}} rather than {{Exception}} already helps to not include all of Java's runtime exceptions, which indicate programming errors, rather than situations that should be recovered.
>   - {{FlinkUncheckedException}} as a Flink-specific subclass of {{RuntimeException}}. That one can come in handy in places where no exceptions were declared, for example when reusing an interface that does not declare exceptions.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)