C# Class kOS.Safe.Persistence.GlobalPath

Represents the location of a directory or a file inside a kOS. It contains a volumeId and a VolumePath.

Inheritance: VolumePath

Show file Open project: KSP-KOS/KOS Class Usage Examples

Public Properties

Property	Type	Description
EMPTY	GlobalPath

Public Methods

Method	Description
ChangeExtension ( string newExtension ) : GlobalPath
ChangeName ( string newName ) : GlobalPath
Combine ( ) : GlobalPath
Equals ( object other ) : bool
FromString ( string pathString ) : GlobalPath	Creates a GlobalPath from string.
FromStringAndBase ( string pathString, GlobalPath basePath ) : GlobalPath	Create a GlobalPath from a base path and a relative path.
FromVolumePath ( VolumePath volumePath, int volumeId ) : GlobalPath
FromVolumePath ( VolumePath volumePath, object volumeId ) : GlobalPath
GetHashCode ( ) : int
GetParent ( ) : GlobalPath
HasVolumeId ( string pathString ) : bool
IsParent ( GlobalPath path ) : bool
RootPath ( ) : GlobalPath
ToString ( ) : string

Protected Methods

Method	Description
GlobalPath ( object volumeId ) : System

Private Methods

Method	Description
GlobalPath ( object volumeId, IEnumerable segments ) : System
GlobalPath ( object volumeId, VolumePath path ) : System
ValidateVolumeId ( object volumeId ) : object

Method Details

ChangeExtension() public method

public ChangeExtension ( string newExtension ) : GlobalPath
newExtension	string
return	GlobalPath

ChangeName() public method

public ChangeName ( string newName ) : GlobalPath
newName	string
return	GlobalPath

Combine() public method

public Combine ( ) : GlobalPath
return	GlobalPath

Equals() public method

public Equals ( object other ) : bool
other	object
return	bool

FromString() public static method

Creates a GlobalPath from string.

public static FromString ( string pathString ) : GlobalPath
pathString	string	Path string.
return	GlobalPath

FromStringAndBase() public static method

Create a GlobalPath from a base path and a relative path.

public static FromStringAndBase ( string pathString, GlobalPath basePath ) : GlobalPath
pathString	string	Path string relative to basePath.
basePath	GlobalPath	Base path.
return	GlobalPath

FromVolumePath() public static method

public static FromVolumePath ( VolumePath volumePath, int volumeId ) : GlobalPath
volumePath	VolumePath
volumeId	int
return	GlobalPath

FromVolumePath() public static method

public static FromVolumePath ( VolumePath volumePath, object volumeId ) : GlobalPath
volumePath	VolumePath
volumeId	object
return	GlobalPath

GetHashCode() public method

public GetHashCode ( ) : int
return	int

GetParent() public method

public GetParent ( ) : GlobalPath
return	GlobalPath

GlobalPath() protected method

protected GlobalPath ( object volumeId ) : System
volumeId	object
return	System

HasVolumeId() public static method

public static HasVolumeId ( string pathString ) : bool
pathString	string
return	bool

IsParent() public method

public IsParent ( GlobalPath path ) : bool
path	GlobalPath
return	bool

RootPath() public method

public RootPath ( ) : GlobalPath
return	GlobalPath

ToString() public method

public ToString ( ) : string
return	string

Property Details

EMPTY public static property

public static GlobalPath,kOS.Safe.Persistence EMPTY
return	GlobalPath