added the javadoc