xml验证器验证API的设计

时间:2018-02-21 21:54:07

标签: java api-design xml-validation

我计划编写验证器方法,并且正在四处寻找实现它的最佳方法。我遇到了javax.xml.validation.Validator类。它有一个method

  

abstract void validate(源代码,结果结果)

验证指定的输入并将扩充的验证结果发送到指定的输出。

这是验证方法的好名字吗?因为,它不仅要验证,还要填充结果字段。 或者更好的设计是返回结果

  

abstract Result validate(源代码)

或将方法称为

  

abstract void validateAndPopulateResult(源代码,结果结果)?

1 个答案:

答案 0 :(得分:0)

对于API设计,我认为你应该看看已经存在的东西。

如果我正在编写Xml验证器的实现,那么我可能会扩展javax.xml.validation.Validator

但即使我正在编写其他类型的文档Validator,我仍然可以遵循javax.xml.validation API的约定。我使用与Validator相同的方法签名,并使用类似的方法函数和文档,但针对我验证的具体情况。

简而言之,我的投票是:

public void validate(Source source, Result result) throws ???Exception, IOException;

public void validate(Source source) throws ???Exception, IOException;