add javadoc to clarify how this is used