oracle.cabo.share.io
Interface InputStreamProvider

All Known Subinterfaces:

CachingInputStreamProvider

All Known Implementing Classes:

FileInputStreamProvider, InputStreamProviderProxy, URLInputStreamProvider

public interface InputStreamProvider

InputStreamProviders encapsulate a single target file. (There's no real requirement that there be a physical file at the target location).

Method Summary

java.lang.Object	getCachedResult() Returns the cached result from reading and parsing this provider.
java.lang.String	getDisplayName() Returns the name of the target location, suitable for user display.
java.lang.Object	getIdentifier() Returns an identifier object that uniquely identifies the target location.
boolean	hasSourceChanged() Returns true if the underlying target has changed since the last call to openInputStream()
java.io.InputStream	openInputStream() Return an InputStream for the target.
void	setCachedResult(java.lang.Object value) Stores the cached result of reading and parsing this provider.

Method Detail

openInputStream

public java.io.InputStream openInputStream()
                                    throws java.io.IOException

Return an InputStream for the target. This function should never return null - if a stream cannot be opened, throw an IOException.

getDisplayName

public java.lang.String getDisplayName()

Returns the name of the target location, suitable for user display.

getIdentifier

public java.lang.Object getIdentifier()

Returns an identifier object that uniquely identifies the target location. If two providers return equal identifiers, that is, given:

   Object identifierA = providerA.getIdentifier();
   Object identifierB = providerB.getIdentifier();
 

... then:

   if (identifierA.equals(identifierB)) ...
 

then the two providers must point to the same location.

hasSourceChanged

public boolean hasSourceChanged()

Returns true if the underlying target has changed since the last call to openInputStream()

getCachedResult

public java.lang.Object getCachedResult()

Returns the cached result from reading and parsing this provider.

See Also:

CachingNameResolver

setCachedResult

public void setCachedResult(java.lang.Object value)

Stores the cached result of reading and parsing this provider.

See Also:

CachingNameResolver