FileInputSource Class Reference

A type of InputSource that represents a normal file. More...

#include <juce_FileInputSource.h>

Inheritance diagram for FileInputSource:

Collaboration diagram for FileInputSource:

Public Member Functions
	FileInputSource (const File &file, bool useFileTimeInHashGeneration=false)
	Creates a FileInputSource for a file. More...
	~FileInputSource ()
	Destructor. More...
InputStream *	createInputStream ()
	Returns a new InputStream to read this item. More...
InputStream *	createInputStreamFor (const String &relatedItemPath)
	Returns a new InputStream to read an item, relative. More...
int64	hashCode () const
	Returns a hash code that uniquely represents this item. More...

Private Attributes
const File	file
bool	useFileTimeInHashGeneration

Detailed Description

A type of InputSource that represents a normal file.

See also

InputSource

Constructor & Destructor Documentation

FileInputSource()

FileInputSource::FileInputSource	(	const File &	file,
		bool	useFileTimeInHashGeneration = false
	)

Creates a FileInputSource for a file.

If the useFileTimeInHashGeneration parameter is true, then this object's hashCode() method will incorporate the file time into its hash code; if false, only the file name will be used for the hash.

~FileInputSource()

FileInputSource::~FileInputSource

(

)

Destructor.

Member Function Documentation

createInputStream()

InputStream* FileInputSource::createInputStream ( )

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.

Implements InputSource.

createInputStreamFor()

InputStream* FileInputSource::createInputStreamFor ( const String &  relatedItemPath )

virtual

Returns a new InputStream to read an item, relative.

Parameters

relatedItemPath

the 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 FileInputSource::hashCode ( ) const

virtual

Returns a hash code that uniquely represents this item.

Implements InputSource.

Member Data Documentation

file

const File FileInputSource::file

private

useFileTimeInHashGeneration

bool FileInputSource::useFileTimeInHashGeneration

private

---

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

• juce_FileInputSource.h