[YANGTOOLS-918] Reconsider design of yang.common.Revision

Fri, 5 Jan 2024 16:28:39 +0000

Current design of QNameModule returning Optional<Revision> may be sub-optimal as evidenced in ~~CONTROLLER-1871~~ and the fact we need Revision.compare(Optional, Optional) and its nullable counterpart.

Reconsider the design such that there are two subclasses of Revision, present and missing, and think about how users can access the underlying string: it is very usual for users to do

QNameModule.getRevision().map(Revision::toString).orElse(null)

QNameModule.getRevision().map(Revision::toString).orElse("")

We could perhaps cater to these with a

class QNameModule {
  Optional<String> getRevisionString() {
    return revision == null ? Optional.empty() : Optional.of(revision.toString());
  }

  @Nullable String revisionString() {
    return revision == null ? null : revision.toString();
  }
}

and then reflect these perhaps in QName as well.

OpenDaylight JIRA

[YANGTOOLS-918] Reconsider design of yang.common.Revision