goog.testing.fs.DirectoryEntry

Provided By	`goog.testing.fs.DirectoryEntry`
Extends	`goog.testing.fs.Entry`
All Implemented Interfaces	`goog.fs.DirectoryEntry` `goog.fs.Entry`

A mock directory entry object.

new DirectoryEntry( `fs`, `parent`, `name`, `children` )

Parameters

`fs`	`goog.testing.fs.FileSystem`
	The filesystem containing this entry.
`parent`	`(goog.testing.fs.DirectoryEntry\|null)`
	The directory entry directly containing this entry. If this is null, that means this is the root directory and so is its own parent.
`name`	`string`
	The name of this entry.
`children`	`Object<?, goog.testing.fs.Entry>`
	The map of child names to entry objects.

VIEW SOURCE

Instance Methods

Return a deferred that will call its errback if this entry has been deleted. In addition, the deferred will only run after a timeout of 0, and all its callbacks will run with the entry as "this".

Defined by

goog.testing.fs.Entry

Parameters

`action`	`string`
	The name of the action being performed. For error reporting.

Returns

goog.async.Deferred

The deferred that will be called after a timeout of 0.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Parameters

None.

Returns

goog.testing.fs.Entry

A shallow copy of this entry object.

VIEW SOURCE

Copy this entry to a new location.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

`parent`	`goog.fs.DirectoryEntry`
	The new parent directory.
`opt_newName`	`string=`
	The name of the new entry. If omitted, the new entry has the same name as the original.

Returns

goog.async.Deferred

The deferred goog.fs.FileEntry or goog.fs.DirectoryEntry for the new entry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Creates a directory synchronously. This is a shorthand for getFileSync, useful for setting up tests.

Parameters

`path`	`string`
	The path to the directory, relative to this directory.

Returns

goog.testing.fs.DirectoryEntry

The created directory.

VIEW SOURCE

Creates a file synchronously. This is a shorthand for getFileSync, useful for setting up tests.

Parameters

`path`	`string`
	The path to the file, relative to this directory.

Returns

goog.testing.fs.FileEntry

The created file.

VIEW SOURCE

Opens the directory for the specified path, creating the directory and any intermediate directories as necessary.

Specified by

goog.fs.DirectoryEntry

Parameters

`path`	`string`
	The directory path to create. May be absolute or relative to the current directory. The parent directory ".." and current directory "." are supported.

Returns

goog.async.Deferred

A deferred goog.fs.DirectoryEntry for the requested path. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Get a directory within this directory.

Specified by

goog.fs.DirectoryEntry

Parameters

`path`	`string`
	The path to the directory, relative to this directory.
`opt_behavior`	`goog.fs.DirectoryEntry.Behavior=`
	The behavior for handling an existing directory, or the lack thereof.

Returns

goog.async.Deferred

The deferred goog.fs.DirectoryEntry. If an error occurs, the errback is called a goog.fs.Error.

VIEW SOURCE

Get a directory synchronously, without waiting for a Deferred to resolve.

Parameters

`path`	`string`
	The path to the directory, relative to this one.
`opt_behavior`	`goog.fs.DirectoryEntry.Behavior=`
	The behavior for loading the directory.

Returns

goog.testing.fs.DirectoryEntry

The loaded directory.

VIEW SOURCE

Get a file in the directory.

Specified by

goog.fs.DirectoryEntry

Parameters

`path`	`string`
	The path to the file, relative to this directory.
`opt_behavior`	`goog.fs.DirectoryEntry.Behavior=`
	The behavior for handling an existing file, or the lack thereof.

Returns

goog.async.Deferred

The deferred goog.fs.FileEntry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Get a file entry synchronously, without waiting for a Deferred to resolve.

Parameters

`path`	`string`
	The path to the file, relative to this directory.
`opt_behavior`	`goog.fs.DirectoryEntry.Behavior=`
	The behavior for loading the file.
`opt_data`	`string=`
	The string data encapsulated by the blob.
`opt_type`	`string=`
	The mime type of the blob.

Returns

goog.testing.fs.FileEntry

The loaded file.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

goog.fs.FileSystem

The filesystem backing this entry.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

string

The full path to this entry.

VIEW SOURCE

Retrieves the last modified date for this entry.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

goog.async.Deferred

The deferred Date for this entry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Retrieves the metadata for this entry.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

goog.async.Deferred

The deferred Metadata for this entry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

string

The name of this entry.

VIEW SOURCE

Gets the parent directory.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

goog.async.Deferred

The deferred goog.fs.DirectoryEntry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Returns whether this directory has a child with the given name.

Parameters

`name`	`string`
	The name of the entry to check for.

Returns

boolean

Whether or not this has a child with the given name.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

boolean

Whether or not this entry is a directory.

VIEW SOURCE

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

boolean

Whether or not this entry is a file.

VIEW SOURCE

Gets a list of all entries in this directory.

Specified by

goog.fs.DirectoryEntry

Parameters

None.

Returns

goog.async.Deferred

The deferred list of goog.fs.Entry results. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Move this entry to a new location.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

`parent`	`goog.fs.DirectoryEntry`
	The new parent directory.
`opt_newName`	`string=`
	The new name of the entry. If omitted, the entry retains its original name.

Returns

goog.async.Deferred

The deferred goog.fs.FileEntry or goog.fs.DirectoryEntry for the new entry. If an error occurs, the errback is called with a goog.fs.Error.

VIEW SOURCE

Remove this entry.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

None.

Returns

goog.async.Deferred

A deferred object. If the removal succeeds, the callback is called with true. If an error occurs, the errback is called a goog.fs.Error.

VIEW SOURCE

Removes this directory and all its contents.

Specified by

goog.fs.DirectoryEntry

Parameters

None.

Returns

goog.async.Deferred

A deferred object. If the removal succeeds, the callback is called with true. If an error occurs, the errback is called a goog.fs.Error.

VIEW SOURCE

Get the URI for this file.

Deprecated	Use `#toUrl` instead.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

`opt_mimeType`	`string=`
	The MIME type that will be served for the URI.

Returns

string

The URI.

VIEW SOURCE

Get the URL for this file.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

`opt_mimeType`	`string=`
	The MIME type that will be served for the URL.

Returns

string

The URL.

VIEW SOURCE

Wrap an HTML5 entry object in an appropriate subclass instance.

Overrides

goog.testing.fs.Entry

Specified by

goog.fs.Entry

Parameters

`entry`	`Entry`
	The underlying Entry object.

Returns

goog.fs.Entry

The appropriate subclass wrapper.

VIEW SOURCE

Instance Properties

The map of child names to entry objects.

VIEW SOURCE

Whether or not this entry has been deleted.

VIEW SOURCE

The parent of this entry.

VIEW SOURCE

goog.testing.fs.DirectoryEntry

new DirectoryEntry( `fs`, `parent`, `name`, `children` )

Instance Methods

`this.`checkNotDeleted( `action` ) `→` `goog.async.Deferred`

`this.`clone() `→` `goog.testing.fs.Entry`

`this.`copyTo( `parent`, `opt_newName` ) `→` `goog.async.Deferred`

`this.`createDirectorySync( `path` ) `→` `goog.testing.fs.DirectoryEntry`

`this.`createFileSync( `path` ) `→` `goog.testing.fs.FileEntry`

`this.`createPath( `path` ) `→` `goog.async.Deferred`

`this.`getDirectory( `path`, `opt_behavior` ) `→` `goog.async.Deferred`

`this.`getDirectorySync( `path`, `opt_behavior` ) `→` `goog.testing.fs.DirectoryEntry`

`this.`getFile( `path`, `opt_behavior` ) `→` `goog.async.Deferred`

`this.`getFileSync( `path`, `opt_behavior`, `opt_data`, `opt_type` ) `→` `goog.testing.fs.FileEntry`

`this.`getFileSystem() `→` `goog.fs.FileSystem`

`this.`getFullPath() `→` `string`

`this.`getLastModified() `→` `goog.async.Deferred`

`this.`getMetadata() `→` `goog.async.Deferred`

`this.`getName() `→` `string`

`this.`getParent() `→` `goog.async.Deferred`

`this.`hasChild( `name` ) `→` `boolean`

`this.`isDirectory() `→` `boolean`

`this.`isFile() `→` `boolean`

`this.`listDirectory() `→` `goog.async.Deferred`

`this.`moveTo( `parent`, `opt_newName` ) `→` `goog.async.Deferred`

`this.`remove() `→` `goog.async.Deferred`

`this.`removeRecursively() `→` `goog.async.Deferred`

`this.`toUri( `opt_mimeType` ) `→` `string`

`this.`toUrl( `opt_mimeType` ) `→` `string`

`this.`wrapEntry( `entry` ) `→` `goog.fs.Entry`

Instance Properties

`this.`children `→` `Object<?, goog.testing.fs.Entry>`

`this.`deleted `→` `boolean`

`this.`parent `→` `goog.testing.fs.DirectoryEntry`

goog.testing.fs.DirectoryEntry

new DirectoryEntry( fs, parent, name, children )

Instance Methods

this.checkNotDeleted( action ) → goog.async.Deferred

this.clone() → goog.testing.fs.Entry

this.copyTo( parent, opt_newName ) → goog.async.Deferred

this.createDirectorySync( path ) → goog.testing.fs.DirectoryEntry

this.createFileSync( path ) → goog.testing.fs.FileEntry

this.createPath( path ) → goog.async.Deferred

this.getDirectory( path, opt_behavior ) → goog.async.Deferred

this.getDirectorySync( path, opt_behavior ) → goog.testing.fs.DirectoryEntry

this.getFile( path, opt_behavior ) → goog.async.Deferred

this.getFileSync( path, opt_behavior, opt_data, opt_type ) → goog.testing.fs.FileEntry

this.getFileSystem() → goog.fs.FileSystem

this.getFullPath() → string

this.getLastModified() → goog.async.Deferred

this.getMetadata() → goog.async.Deferred

this.getName() → string

this.getParent() → goog.async.Deferred

this.hasChild( name ) → boolean

this.isDirectory() → boolean

this.isFile() → boolean

this.listDirectory() → goog.async.Deferred

this.moveTo( parent, opt_newName ) → goog.async.Deferred

this.remove() → goog.async.Deferred

this.removeRecursively() → goog.async.Deferred

this.toUri( opt_mimeType ) → string

this.toUrl( opt_mimeType ) → string

this.wrapEntry( entry ) → goog.fs.Entry

Instance Properties

this.children → Object<?, goog.testing.fs.Entry>

this.deleted → boolean

this.parent → goog.testing.fs.DirectoryEntry

new DirectoryEntry( `fs`, `parent`, `name`, `children` )

`this.`checkNotDeleted( `action` ) `→` `goog.async.Deferred`

`this.`clone() `→` `goog.testing.fs.Entry`

`this.`copyTo( `parent`, `opt_newName` ) `→` `goog.async.Deferred`

`this.`createDirectorySync( `path` ) `→` `goog.testing.fs.DirectoryEntry`

`this.`createFileSync( `path` ) `→` `goog.testing.fs.FileEntry`

`this.`createPath( `path` ) `→` `goog.async.Deferred`

`this.`getDirectory( `path`, `opt_behavior` ) `→` `goog.async.Deferred`

`this.`getDirectorySync( `path`, `opt_behavior` ) `→` `goog.testing.fs.DirectoryEntry`

`this.`getFile( `path`, `opt_behavior` ) `→` `goog.async.Deferred`

`this.`getFileSync( `path`, `opt_behavior`, `opt_data`, `opt_type` ) `→` `goog.testing.fs.FileEntry`

`this.`getFileSystem() `→` `goog.fs.FileSystem`

`this.`getFullPath() `→` `string`

`this.`getLastModified() `→` `goog.async.Deferred`

`this.`getMetadata() `→` `goog.async.Deferred`

`this.`getName() `→` `string`

`this.`getParent() `→` `goog.async.Deferred`

`this.`hasChild( `name` ) `→` `boolean`

`this.`isDirectory() `→` `boolean`

`this.`isFile() `→` `boolean`

`this.`listDirectory() `→` `goog.async.Deferred`

`this.`moveTo( `parent`, `opt_newName` ) `→` `goog.async.Deferred`

`this.`remove() `→` `goog.async.Deferred`

`this.`removeRecursively() `→` `goog.async.Deferred`

`this.`toUri( `opt_mimeType` ) `→` `string`

`this.`toUrl( `opt_mimeType` ) `→` `string`

`this.`wrapEntry( `entry` ) `→` `goog.fs.Entry`

`this.`children `→` `Object<?, goog.testing.fs.Entry>`

`this.`deleted `→` `boolean`

`this.`parent `→` `goog.testing.fs.DirectoryEntry`