updated javadoc to describe where it is used.