juce::AndroidDocumentInfo Class Reference

#include <juce_AndroidDocument.h>

Public Member Functions
	AndroidDocumentInfo ()=default
bool	exists () const
bool	isDirectory () const
bool	isFile () const
bool	canRead () const
bool	canWrite () const
bool	canDelete () const
bool	canCreateChildren () const
bool	canRename () const
bool	canCopy () const
bool	canMove () const
bool	isVirtual () const
String	getName () const
String	getType () const
int64	getLastModified () const
bool	isLastModifiedValid () const
int64	getSizeInBytes () const
bool	isSizeInBytesValid () const

Private Types
enum	{   flagSupportsWrite = 0x0002 , flagSupportsDelete = 0x0004 , flagDirSupportsCreate = 0x0008 , flagSupportsRename = 0x0040 ,   flagSupportsCopy = 0x0080 , flagSupportsMove = 0x0100 , flagVirtualDocument = 0x0200 }
enum	{   flagExists = 1 << 0 , flagValidModified = 1 << 1 , flagValidSize = 1 << 2 , flagHasReadPermission = 1 << 3 ,   flagHasWritePermission = 1 << 4 }

Private Member Functions
	AndroidDocumentInfo (Args)
bool	isNativeFlagSet (int flag) const
bool	isJuceFlagSet (int flag) const

Private Attributes
String	name
String	type
int64	lastModified = 0
int64	sizeInBytes = 0
int	nativeFlags = 0
int	juceFlags = 0

Detailed Description

Some information about a document.

Each instance represents some information about the document at the point when the instance was created.

Instance information is not updated automatically. If you think some file information may have changed, create a new instance.

@tags{Core}

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
flagExists
flagValidModified
flagValidSize
flagHasReadPermission
flagHasWritePermission

anonymous enum

anonymous enum

private

Enumerator
flagSupportsWrite
flagSupportsDelete
flagDirSupportsCreate
flagSupportsRename
flagSupportsCopy
flagSupportsMove
flagVirtualDocument

Constructor & Destructor Documentation

AndroidDocumentInfo() [1/2]

juce::AndroidDocumentInfo::AndroidDocumentInfo ( )

default

AndroidDocumentInfo() [2/2]

juce::AndroidDocumentInfo::AndroidDocumentInfo ( Args )

explicitprivate

Member Function Documentation

canCopy()

bool juce::AndroidDocumentInfo::canCopy ( ) const

inline

True if this document can be copied.

canCreateChildren()

bool juce::AndroidDocumentInfo::canCreateChildren ( ) const

inline

True if this is a directory and adding child documents is supported.

canDelete()

bool juce::AndroidDocumentInfo::canDelete ( ) const

inline

True if this document can be removed completely from the filesystem.

canMove()

bool juce::AndroidDocumentInfo::canMove ( ) const

inline

True if this document can be moved.

canRead()

bool juce::AndroidDocumentInfo::canRead ( ) const

inline

True if this process has permission to read this file.

If this returns true, and the AndroidDocument refers to a file rather than a directory, then AndroidDocument::createInputStream should work on this document.

canRename()

bool juce::AndroidDocumentInfo::canRename ( ) const

inline

True if this document can be renamed.

canWrite()

bool juce::AndroidDocumentInfo::canWrite ( ) const

inline

True if this is a document that can be written, or a directory that can be modified.

If this returns true, and the AndroidDocument refers to a file rather than a directory, then AndroidDocument::createOutputStream should work on this document.

exists()

bool juce::AndroidDocumentInfo::exists ( ) const

inline

True if this file really exists.

getLastModified()

int64 juce::AndroidDocumentInfo::getLastModified ( ) const

inline

Timestamp when a document was last modified, in milliseconds since January 1, 1970 00:00:00.0 UTC.

Use isLastModifiedValid() to determine whether or not the result of this function is valid.

getName()

String juce::AndroidDocumentInfo::getName ( ) const

inline

The user-facing name.

This may or may not contain a file extension. For files identified by a URL, the MIME type is stored separately.

getSizeInBytes()

int64 juce::AndroidDocumentInfo::getSizeInBytes ( ) const

inline

The size of the document in bytes, if known.

Use isSizeInBytesValid() to determine whether or not the result of this function is valid.

getType()

String juce::AndroidDocumentInfo::getType ( ) const

inline

The MIME type of this document.

isDirectory()

bool juce::AndroidDocumentInfo::isDirectory

(

)

const

True if this is a directory rather than a file.

isFile()

bool juce::AndroidDocumentInfo::isFile ( ) const

inline

True if this is a file rather than a directory.

isJuceFlagSet()

bool juce::AndroidDocumentInfo::isJuceFlagSet ( int flag ) const

inlineprivate

isLastModifiedValid()

bool juce::AndroidDocumentInfo::isLastModifiedValid ( ) const

inline

True if the filesystem provided a modification time.

isNativeFlagSet()

bool juce::AndroidDocumentInfo::isNativeFlagSet ( int flag ) const

inlineprivate

isSizeInBytesValid()

bool juce::AndroidDocumentInfo::isSizeInBytesValid ( ) const

inline

True if the filesystem provided a size in bytes.

isVirtual()

bool juce::AndroidDocumentInfo::isVirtual ( ) const

inline

True if this document isn't a physical file on storage.

Member Data Documentation

juceFlags

int juce::AndroidDocumentInfo::juceFlags = 0

private

lastModified

int64 juce::AndroidDocumentInfo::lastModified = 0

private

name

String juce::AndroidDocumentInfo::name

private

nativeFlags

int juce::AndroidDocumentInfo::nativeFlags = 0

private

sizeInBytes

int64 juce::AndroidDocumentInfo::sizeInBytes = 0

private

type

String juce::AndroidDocumentInfo::type

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_core/files/juce_AndroidDocument.h