Document {Config,Status}EffectiveStatement as exceptional 31/104131/2
authorRobert Varga <robert.varga@pantheon.tech>
Wed, 25 Jan 2023 04:07:52 +0000 (05:07 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Thu, 26 Jan 2023 12:21:38 +0000 (13:21 +0100)
commit9c570d53e902018a42222ed344d0e3336113a346
tree7901719c6e86465c2eff450ca0b3da65a6be46d2
parent62364df0873c367e4b8063c4c92614e60b207e4f
Document {Config,Status}EffectiveStatement as exceptional

These two statements have a counter-intuitive lifecycle dictated
by scalability concerns. While we could go the other way and instantiate
effective views, the information conveyed is not consulted often and
lends itself to extenal caching. Document the object model behaviour of
these two statements, providing explanation and hints to end users.

JIRA: YANGTOOLS-1271
JIRA: YANGTOOLS-1272
Change-Id: I20ac9e3aae0d0cbae37c5671649cde7347016dd8
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/meta/ModelStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/ConfigEffectiveStatement.java
model/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/stmt/StatusEffectiveStatement.java