[OPENNLP-1044] Add validate() which checks validity of parameters in the process of the framework

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.8.0
• Assignee: Koji Sekiguchi
• Reporter: Koji Sekiguchi
• Created: 24/Apr/17 04:54
• Updated: 08/May/17 02:07
• Resolved: 08/May/17 02:07

Description

When I worked on OPENNLP-1039, I saw the client codes throw IllegalArgumentException when isValid() returns false, but I think such kind of methods should throw the Exception by themselves and the timing of use should be controlled by the framework.

So it should look like:

public abstract class AbstractTrainer {
  @Depracated
  public boolean isValid() { ... }

  // if the subclass overrides this, it should call super.validate();
  public void validate() throws IllegalArgumentException {
    // default implementation here
  }

  // this is the controller of the flow of training...
  public final void train() {
    // initializing 
    init();

    // validating parameters
    validate();
  }
}

Issue Links

• links to: GitHub Pull Request #192