[ROASTER-44] add helpful Javadoc