Skip to content

Commit

Permalink
Update ClassLoaderFacet JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
lincolnthree committed Jan 21, 2015
1 parent 26232ed commit 7c938e4
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
public interface ClassLoaderFacet extends ProjectFacet
{
/**
* Returns the {@link URLClassLoader} with the {@link URL}s that this project depends on.
* Returns a {@link URLClassLoader} that encompasses all {@link Dependency} instances on which this project depends. This is the equivalent of class-loading the entire project classpath.
*
* WARNING: Remember to close this {@link URLClassLoader} when no longer in use.
* WARNING: You *MUST* call {@link URLClassLoader#close()} when finished with this object. Failure to close this object upon completion will result in fatal memory leaks over time. If the scope of work is appropriate, consider using a try-with-resources block to encapsulate the operations and automatically clean up any ClassLoader resources.
* <p/>
* Leaving it open could introduce memory leaks.
* IMPORTANT: You must also clean up and release any {@link Class} references that were produced by this {@link ClassLoader}. It is not enough to close this. Held {@link Class} references will keep the {@link ClassLoader} from being garbage collected.
*/
URLClassLoader getClassLoader();

Expand Down

0 comments on commit 7c938e4

Please sign in to comment.