FileSpecification Class Reference

#include <molequeue/filespecification.h>

Public Types
enum	Format {   InvalidFileSpecification = -1 ,   PathFileSpecification = 0 ,   ContentsFileSpecification }

Public Member Functions
	FileSpecification ()
	FileSpecification (const QJsonObject &json)
	FileSpecification (const QString &path)
	FileSpecification (const QString &filename_, const QString &contents_)
	FileSpecification (QFile *file, Format format_=PathFileSpecification)
	FileSpecification (const FileSpecification &other)
FileSpecification &	operator= (const FileSpecification &other)
	~FileSpecification ()
Format	format () const
bool	isValid () const
QByteArray	toJson () const
QJsonObject	toJsonObject () const
bool	fileExists () const
bool	writeFile (const QDir &dir, const QString &filename_=QString()) const
QString	filename () const
QString	contents () const
QString	filepath () const
bool	fileHasExtension () const
QString	fileBaseName () const
QString	fileExtension () const

Detailed Description

Specify files for simplifying Client-Server communication.

Author

Allison Vacanti

The FileSpecification class contains a description of a file to facilite file manipulation during RPC communication. Files are stored as either a path to the local file on disk, or a filename and content string.

Member Enumeration Documentation

Format

enum Format

Recognized internal formats for storing file data.

Enumerator
InvalidFileSpecification	Invalid format.
PathFileSpecification	Single "path" member pointing to a location on the filesystem.
ContentsFileSpecification	Filename and content strings.

Constructor & Destructor Documentation

FileSpecification() [1/6]

FileSpecification

(

)

Creates an invalid FileSpecification.

FileSpecification() [2/6]

FileSpecification ( const QJsonObject & json )

explicit

Create a FileSpecification using the members of the input QJsonObject.

FileSpecification() [3/6]

FileSpecification ( const QString & path )

explicit

Create a FileSpecification from the input absolute filepath.

FileSpecification() [4/6]

FileSpecification	(	const QString &	filename_,
		const QString &	contents_ )

Create a FileSpecification from the filename and content strings.

FileSpecification() [5/6]

FileSpecification	(	QFile *	file,
		Format	format_ = PathFileSpecification )

Create a FileSpecification from the specified file using the indicated format

FileSpecification() [6/6]

FileSpecification

(

const FileSpecification &

other

)

Copy a FileSpecification.

~FileSpecification()

~FileSpecification

(

)

Destroy the FileSpec.

Member Function Documentation

operator=()

FileSpecification & operator=

(

const FileSpecification &

other

)

Copy a FileSpecification.

format()

Format format

(

)

const

Returns

The format of the FileSpec

See also

FileSpecification::Format

isValid()

bool isValid

(

)

const

Returns

True if the FileSpecification is formatted properly, false otherwise.

toJson()

QByteArray toJson

(

)

const

Returns

The FileSpecification as a formatted JSON string.

toJsonObject()

QJsonObject toJsonObject

(

)

const

Returns

The FileSpecification as a formatted JSON string.

fileExists()

bool fileExists

(

)

const

Returns

Whether or not the FileSpecification refers to an existing file

Note

This will always be false if format() does not return ContentsFileSpecification.

writeFile()

bool writeFile	(	const QDir &	dir,
		const QString &	filename_ = QString() ) const

Write contents() to a file with filename_ in dir. If filename is not specified, filename() will be used instead (default).

Returns

True if the file is successfully written.

filename()

QString filename

(

)

const

Returns

The filename (without path) of the FileSpecification.

contents()

QString contents

(

)

const

Returns

The contents of the file.

filepath()

QString filepath

(

)

const

Returns

The filename (with path) of the FileSpecification.

Note

This function only makes sense if format() is PathFileSpecification. It will always return a null string otherwise.

fileHasExtension()

bool fileHasExtension

(

)

const

Returns

True if the filename has an extension ("file.ext"), false otherwise ("file")

fileBaseName()

QString fileBaseName

(

)

const

Returns

The filename without an extension.

fileExtension()

QString fileExtension

(

)

const

Returns

The file extension, if any, or a null string.

See also

hasFileExtension

---

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

• filespecification.h