Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

oracle.cabo.share.io
Class InputStreamProviderProxy

java.lang.Object
  |
  +--oracle.cabo.share.io.InputStreamProviderProxy
All Implemented Interfaces:
InputStreamProvider

public abstract class InputStreamProviderProxy
extends java.lang.Object
implements InputStreamProvider

Proxying class for InputStreamProviders. Subclassers must override getProvider().


Constructor Summary
InputStreamProviderProxy()
          Create an InputStreamProviderProxy.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 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.
protected abstract  InputStreamProvider getProvider()
          Return the provider being proxied.
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InputStreamProviderProxy

public InputStreamProviderProxy()
Create an InputStreamProviderProxy.
Method Detail

getProvider

protected abstract InputStreamProvider getProvider()
Return the provider being proxied.

openInputStream

public java.io.InputStream openInputStream()
                                    throws java.io.IOException
Description copied from interface: InputStreamProvider
Return an InputStream for the target. This function should never return null - if a stream cannot be opened, throw an IOException.
Specified by:
openInputStream in interface InputStreamProvider

getDisplayName

public java.lang.String getDisplayName()
Description copied from interface: InputStreamProvider
Returns the name of the target location, suitable for user display.
Specified by:
getDisplayName in interface InputStreamProvider

getIdentifier

public java.lang.Object getIdentifier()
Description copied from interface: InputStreamProvider
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.
Specified by:
getIdentifier in interface InputStreamProvider

hasSourceChanged

public boolean hasSourceChanged()
Description copied from interface: InputStreamProvider
Returns true if the underlying target has changed since the last call to openInputStream()
Specified by:
hasSourceChanged in interface InputStreamProvider

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getCachedResult

public java.lang.Object getCachedResult()
Description copied from interface: InputStreamProvider
Returns the cached result from reading and parsing this provider.
Specified by:
getCachedResult in interface InputStreamProvider
Following copied from interface: oracle.cabo.share.io.InputStreamProvider
See Also:
CachingNameResolver

setCachedResult

public void setCachedResult(java.lang.Object value)
Description copied from interface: InputStreamProvider
Stores the cached result of reading and parsing this provider.
Specified by:
setCachedResult in interface InputStreamProvider
Following copied from interface: oracle.cabo.share.io.InputStreamProvider
See Also:
CachingNameResolver

Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

Copyright © 2002,2003, Oracle. All Rights Reserved.