Package org.glassfish.jersey.server.internal.scanning

Class JarFileScanner

java.lang.Object

org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter

org.glassfish.jersey.server.internal.scanning.JarFileScanner

All Implemented Interfaces:

AutoCloseable, Iterator<String>, ResourceFinder

public final class JarFileScanner
extends AbstractResourceFinderAdapter

A utility class that scans entries in jar files.

Author:

Paul Sandoz

Constructor Summary

Constructors

Constructor	Description
JarFileScanner(InputStream inputStream, String parent, boolean recursive)	Create new JAR file scanner.

Method Summary

Modifier and Type	Method	Description
void	close()	Default implementation of #close() which does nothing.
boolean	hasNext()
String	next()
InputStream	open()	Open current resource.
void	reset()	Reset the ResourceFinder instance.

Methods inherited from class org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter

remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

JarFileScanner

public JarFileScanner(InputStream inputStream,
                      String parent,
                      boolean recursive)
               throws IOException

Create new JAR file scanner.

Parameters:

inputStream - JAR file input stream

parent - JAR file entry prefix.

recursive - if (true the packages will be scanned recursively together with any nested packages, if false only the explicitly listed packages will be scanned.

Throws:

IOException - if wrapping given input stream into JarInputStream failed.

Method Detail

hasNext

public boolean hasNext()

next

public String next()

reset

public void reset()

Description copied from interface: ResourceFinder

Reset the ResourceFinder instance.

Upon calling this method the implementing class MUST reset its internal state to the initial state.

open

public InputStream open()

Description copied from interface: ResourceFinder

Open current resource.

Returns:

input stream from which current resource can be loaded.

close

public void close()

Description copied from class: AbstractResourceFinderAdapter

Default implementation of #close() which does nothing.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ResourceFinder

Overrides:

close in class AbstractResourceFinderAdapter