AbstractPath Class

Summary: An AbstractPath is a base class for classes that specify a unique location in an environment similar to a filesystem,
like a local filesystem, a remote file storage or a ZIP archive, among others.

Module: aspose.gis

Full Name: aspose.gis.AbstractPath

Aspose.PSD Version: 25.9.0

Properties

Name	Type	Access	Description
location	string	r	Gets a string representation of the location of this AbstractPath.
separator	char	r	Gets a separator character used to separate directory levels of the AbstractPath.location string.

Methods

Name	Description
combine(location)	Combines this AbstractPath with specified path components.
delete()	Deletes a file pointed to by this path.
from_local_path(path)	Creates an AbstractPath that represents a location on the local filesystem.
from_stream(stream)	Creates an AbstractPath from a stream.
get_extension()	Returns the extension of this AbstractPath.
get_file_name()	Returns the file name and extension of this AbstractPath.
get_file_name_without_extension()	Returns the file name of this AbstractPath without the extension.
is_file()	Gets a value indicating whether this path points to an existing file that can be opened for reading.
list_directory()	Returns paths located inside this AbstractPath, if it’s a directory.
open(access)	Opens this AbstractPath as a file.
with_extension(new_extension)	Returns a new AbstractPath with the file extension changed to the specified value.

Method: combine(location)

 combine(location) 

Combines this AbstractPath with specified path components.

Parameters:

Parameter	Type	Description
location	string	A path component to append to this AbstractPath.

Returns

Type	Description
AbstractPath	A new AbstractPath pointing to a AbstractPath.location that is a combination of locations of this AbstractPath and the argument.

Method: from_local_path(path) [static]

 from_local_path(path) 

Creates an AbstractPath that represents a location on the local filesystem.

Parameters:

Parameter	Type	Description
path	string	A path on the local filesystem, like “C:\file.shp” or “D:\directory\".

Returns

Type	Description
AbstractPath	An AbstractPath that represents the location defined by the .

Method: from_stream(stream) [static]

 from_stream(stream) 

Creates an AbstractPath from a stream.

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom	A stream to create an AbstractPath from. Aspose.GIS does not dispose the stream.

Returns

Type	Description
AbstractPath	An instance of AbstractPath with the specified stream as its content.

Method: get_extension()

 get_extension() 

Returns the extension of this AbstractPath.

Returns

Type	Description
string	The extension of this AbstractPath (including the period “.”) or an empty string if the AbstractPath has no extension.

Method: get_file_name()

 get_file_name() 

Returns the file name and extension of this AbstractPath.

Returns

Type	Description
string	The characters after the last AbstractPath.separator character in the AbstractPath.location. If the last character is the AbstractPath.separator character, an empty string is returned. If there is no AbstractPath.separator characters in the AbstractPath.location, the AbstractPath.location itself is returned.

Method: get_file_name_without_extension()

 get_file_name_without_extension() 

Returns the file name of this AbstractPath without the extension.

Returns

Type	Description
string	The string returned by AbstractPath.get_file_name() minus the last period and all characters following it.

Method: is_file()

 is_file() 

Gets a value indicating whether this path points to an existing file that can be opened for reading.

Returns

Type	Description
bool	if location points to a file; otherwise.

Method: list_directory()

 list_directory() 

Returns paths located inside this AbstractPath, if it’s a directory.

Returns

Type	Description
System.Collections.Generic.IEnumerable	Paths located inside this AbstractPath.

Method: open(access)

 open(access) 

Opens this AbstractPath as a file.

Parameters:

Parameter	Type	Description
access	System.IO.FileAccess	Specifies a subset of operations that can be performed on a stream.

Returns

Type	Description
_io.BufferedRandom	A stream opened with the specified FileAccess.

Method: with_extension(new_extension)

 with_extension(new_extension) 

Returns a new AbstractPath with the file extension changed to the specified value.

Parameters:

Parameter	Type	Description
new_extension	string	A new extension.

Returns

Type	Description
AbstractPath	A new AbstractPath, that points to a file in the same directory, but with a new extension.