Public Member Functions | List of all members
URLInputSource Class Reference

A type of InputSource that represents a URL. More...

Inheritance diagram for URLInputSource:

Public Member Functions

 URLInputSource (const URL &url)
 Creates a URLInputSource for a url. More...
 
 URLInputSource (URL &&url)
 Move constructor which will move the URL into the InputSource. More...
 
 ~URLInputSource () override
 Destructor. More...
 
InputStreamcreateInputStream () override
 Returns a new InputStream to read this item. More...
 
InputStreamcreateInputStreamFor (const String &relatedItemPath) override
 Returns a new InputStream to read an item, relative. More...
 
int64 hashCode () const override
 Returns a hash code that uniquely represents this item. More...
 
- Public Member Functions inherited from InputSource
 InputSource ()=default
 
virtual ~InputSource ()=default
 Destructor. More...
 

Detailed Description

A type of InputSource that represents a URL.

See also
InputSource

Constructor & Destructor Documentation

◆ URLInputSource() [1/2]

URLInputSource::URLInputSource ( const URL url)

Creates a URLInputSource for a url.

◆ URLInputSource() [2/2]

URLInputSource::URLInputSource ( URL &&  url)

Move constructor which will move the URL into the InputSource.

This is useful when the url carries any security credentials.

◆ ~URLInputSource()

URLInputSource::~URLInputSource ( )
override

Destructor.

Member Function Documentation

◆ createInputStream()

InputStream* URLInputSource::createInputStream ( )
overridevirtual

Returns a new InputStream to read this item.

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

Implements InputSource.

◆ createInputStreamFor()

InputStream* URLInputSource::createInputStreamFor ( const String relatedItemPath)
overridevirtual

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.

Implements InputSource.

◆ hashCode()

int64 URLInputSource::hashCode ( ) const
overridevirtual

Returns a hash code that uniquely represents this item.

Implements InputSource.


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