Leave private components alone - SchwarzIT/sap-usi-logging-api GitHub Wiki

Some components of this API are considered "public", while others are considered "private".

• public components are safe-to-use and will remain stable in subsequent releases
• private components might change anytime without further notice and therefore MUST NOT be used

If you are using the API as intended and described in this documentation, you should never get in contact with anything, that is considered private. The central factory and the main interfaces are public and everything, that is used by these objects is public as well.

It only gets dangerous, when you explore the package strucutre yourself and start to use "random" things without checking, if they are actually public.

Whenever in doubt, you can easily check, if an object is public by checking the where-used-list of the object. Public objects are exposed by a package interfaces having a name, that ends on '_REUSE'. If such a package interface appears in the where-used-list, the object is safe-to-use. Otherwise - for your own good - LEAVE IT ALONE!

HINT: You can automatically check this rule by enabling package checks for your development system and by adding the package check to your default ATC check variant.