PLAT-6557 add javadoc