C# Class Universe.Modules.Archivers.InventoryArchiveUtils

Utility methods for inventory archiving
ファイルを表示 Open project: Virtual-Universe/Virtual-Universe Class Usage Examples

Public Properties

Property Type Description
ESCAPE_CHARACTER char
PATH_DELIMITER char

Public Methods

Method Description
EscapeArchivePath ( string path ) : string

Escape an archive path.

FindFolderByPath ( IInventoryService inventoryService, InventoryFolderBase startFolder, string path ) : List

Find a folder given a PATH_DELIMITER delimited path starting from this folder

FindFolderByPath ( IInventoryService inventoryService, UUID userId, string path ) : List

Find a folder given a PATH_DELIMITER delimited path starting from a user's root folder

FindItemByPath ( IInventoryService inventoryService, InventoryFolderBase startFolder, string path ) : InventoryItemBase

Find an item given a PATH_DELIMITOR delimited path starting from this folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.

FindItemByPath ( IInventoryService inventoryService, UUID userId, string path ) : InventoryItemBase

Find an item given a PATH_DELIMITOR delimited path starting from the user's root folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.

SplitEscapedPath ( string path ) : string[]

Split a human escaped path into two components if it contains an un-escaped path delimiter, or one component if no delimiter is present

UnescapeArchivePath ( string path ) : string

Un-escape an archive path.

UnescapePath ( string path ) : string

Un-escapes a human escaped path. This means that "\\" goes to "\", and "\/" goes to "/"

Method Details

EscapeArchivePath() public static method

Escape an archive path.
public static EscapeArchivePath ( string path ) : string
path string
return string

FindFolderByPath() public static method

Find a folder given a PATH_DELIMITER delimited path starting from this folder
public static FindFolderByPath ( IInventoryService inventoryService, InventoryFolderBase startFolder, string path ) : List
inventoryService IInventoryService /// Inventory service to query ///
startFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase /// The folder from which the path starts ///
path string /// The path to the required folder. /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned. ///
return List

FindFolderByPath() public static method

Find a folder given a PATH_DELIMITER delimited path starting from a user's root folder
public static FindFolderByPath ( IInventoryService inventoryService, UUID userId, string path ) : List
inventoryService IInventoryService /// Inventory service to query ///
userId UUID /// User id to search ///
path string /// The path to the required folder. /// It this is empty or consists only of the PATH_DELIMTER then this folder itself is returned. ///
return List

FindItemByPath() public static method

Find an item given a PATH_DELIMITOR delimited path starting from this folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.
public static FindItemByPath ( IInventoryService inventoryService, InventoryFolderBase startFolder, string path ) : InventoryItemBase
inventoryService IInventoryService /// Inventory service to query ///
startFolder Universe.Framework.Services.ClassHelpers.Inventory.InventoryFolderBase /// The folder from which the path starts ///
path string /// The path to the required item. ///
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase

FindItemByPath() public static method

Find an item given a PATH_DELIMITOR delimited path starting from the user's root folder. This method does not handle paths that contain multiple delimiters FIXME: We do not yet handle situations where folders or items have the same name. We could handle this by some XPath like expression FIXME: Delimiters which occur in names themselves are not currently escapable.
public static FindItemByPath ( IInventoryService inventoryService, UUID userId, string path ) : InventoryItemBase
inventoryService IInventoryService /// Inventory service to query ///
userId UUID /// The user to search ///
path string /// The path to the required item. ///
return Universe.Framework.Services.ClassHelpers.Inventory.InventoryItemBase

SplitEscapedPath() public static method

Split a human escaped path into two components if it contains an un-escaped path delimiter, or one component if no delimiter is present
public static SplitEscapedPath ( string path ) : string[]
path string
return string[]

UnescapeArchivePath() public static method

Un-escape an archive path.
public static UnescapeArchivePath ( string path ) : string
path string
return string

UnescapePath() public static method

Un-escapes a human escaped path. This means that "\\" goes to "\", and "\/" goes to "/"
public static UnescapePath ( string path ) : string
path string
return string

Property Details

ESCAPE_CHARACTER public_oe static_oe property

public static char ESCAPE_CHARACTER
return char

PATH_DELIMITER public_oe static_oe property

public static char PATH_DELIMITER
return char