JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
InputSource Class Referenceabstract

A lightweight object that can create a stream to read some kind of resource. More...

Inherited by FileInputSource.

Public Member Functions

 InputSource () noexcept
 
virtual ~InputSource ()
 Destructor.
 
virtual InputStreamcreateInputStream ()=0
 Returns a new InputStream to read this item.
 
virtual InputStreamcreateInputStreamFor (const String &relatedItemPath)=0
 Returns a new InputStream to read an item, relative.
 
virtual int64 hashCode () const =0
 Returns a hash code that uniquely represents this item.
 

Detailed Description

A lightweight object that can create a stream to read some kind of resource.

This may be used to refer to a file, or some other kind of source, allowing a caller to create an input stream that can read from it when required.

See Also
FileInputSource

Constructor & Destructor Documentation

InputSource::InputSource ( )
noexcept
virtual InputSource::~InputSource ( )
virtual

Destructor.

Member Function Documentation

virtual InputStream* InputSource::createInputStream ( )
pure virtual

Returns a new InputStream to read this item.

Returns
an inputstream that the caller will delete, or nullptr if the filename isn't found.

Implemented in FileInputSource.

virtual InputStream* InputSource::createInputStreamFor ( const String relatedItemPath)
pure virtual

Returns a new InputStream to read an item, relative.

Parameters
relatedItemPaththe relative pathname of the resource that is required
Returns
an inputstream that the caller will delete, or nullptr if the item isn't found.

Implemented in FileInputSource.

virtual int64 InputSource::hashCode ( ) const
pure virtual

Returns a hash code that uniquely represents this item.

Implemented in FileInputSource.


The documentation for this class was generated from the following file: