Package org.glassfish.jersey.server
Interface ResourceFinder
-
- All Superinterfaces:
AutoCloseable,Iterator<String>
- All Known Implementing Classes:
AbstractResourceFinderAdapter
public interface ResourceFinder extends Iterator<String>, AutoCloseable
An interface used for finding and opening (loading) new resources.ResourceConfigwill use all registered finders to obtain classes to be used as resource classes and/or providers. Methodopen()doesn't need to be called on all returned resource names,ResourceConfigcan ignore some of them. Currently, all resource names ending with ".class" will be accepted and processed (opened). ExtendsAutoCloseablesince version 2.19. Theclose()method is used to release allocated/opened resources (such as streams). When a resource finder is closed no other method should be invoked on it.- Author:
- Pavel Bucek
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()InputStreamopen()Open current resource.voidremove()voidreset()Reset theResourceFinderinstance.-
Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next
-
-
-
-
Method Detail
-
open
InputStream open()
Open current resource.- Returns:
- input stream from which current resource can be loaded.
-
close
void close()
Release allocated/opened resources (such as streams). When the resource finder is closed no other method should be invoked on it.- Specified by:
closein interfaceAutoCloseable- Since:
- 2.19
-
reset
void reset()
Reset theResourceFinderinstance. Upon calling this method the implementing class MUST reset its internal state to the initial state.
-
remove
void remove()
This operation is not supported byResourceFinder& throwsUnsupportedOperationExceptionwhen invoked.
-
-