add a javadoc comment on what the general job of this method is