[hotfix][table-common] Simplify formatted exceptions

[twalthr]

What is the purpose of the change

Makes formatted exceptions easier and helps by providing some simple coding guidelines in the JavaDocs.

Brief change log

• New constructors for TableException and ValidationException

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

• Dependencies (does it add or upgrade a dependency): no
• The public API, i.e., is any changed class annotated with @Public(Evolving): yes
• The serializers: no
• The runtime per-record code paths (performance sensitive): no
• Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: no
• The S3 file system connector: no

Documentation

• Does this pull request introduce a new feature? no
• If yes, how is the feature documented? JavaDocs

[flinkbot]

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 6d7cd66 (Mon Jan 13 07:40:27 UTC 2020)

Warnings:

• No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

• ❓ 1. The [description] looks good.
• ❓ 2. There is [consensus] that the contribution should go into to Flink.
• ❓ 3. Needs [attention] from.
• ❓ 4. The change fits into the overall [architecture].
• ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

• @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
• @flinkbot approve all to approve all aspects
• @flinkbot approve-until architecture to approve everything until architecture
• @flinkbot attention @username1 [@username2 ..] to require somebody's attention
• @flinkbot disapprove architecture to remove an approval you gave earlier

[flinkbot]

CI report:

• 6d7cd66 Travis: FAILURE Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

• @flinkbot run travis re-run the last Travis build
• @flinkbot run azure re-run the last Azure build

[dawidwys]

This solution has one caveat that it is not very intuitive. I think we all (java coders) are used to passing the exception at the end. I'm afraid this solution might be surprising for a lot of newcomers.

How about we rather add a builder:

public static TableExceptionBuilder tableException(String format, Object... args);

class TableExceptionBuilder {
    TableException cause(Throwable cause);

    TableException build();
}

Or if we want to get rid off the build method:

class TableException {
    public static TableException tableException(String format, Object... args);

    public TableException cause(Throwable cause) {
        return new TableException(getMessage(), cause);
    }
}

[twalthr]

I'm fine with a builder approach. This also allows us to include error codes and other properties (such as severity) in the future. I will update the PR.

[twalthr]

Closing this as it has never got enough attention.