Interface IEnvVarDirectoryPath

Namespace

NDepend.Path

Assembly

NDepend.API.dll

Represents a directory path on file system, prefixed with an environment variable.

public interface IEnvVarDirectoryPath : IDirectoryPath, IEnvVarPath, IPath

Inherited Members

IDirectoryPath.TryGetBrotherFileWithName(string, out IFilePath, out string)

IDirectoryPath.TryGetBrotherDirectoryWithName(string, out IDirectoryPath, out string)

IDirectoryPath.TryGetChildFileWithName(string, out IFilePath, out string)

IDirectoryPath.TryGetChildDirectoryWithName(string, out IDirectoryPath, out string)

IDirectoryPath.DirectoryName

IEnvVarPath.TryResolve(out IAbsolutePath)

IEnvVarPath.TryResolve(out IAbsolutePath, out string)

IEnvVarPath.EnvVar

IEnvVarPath.ParentDirectoryPath

IPath.IsChildOf(IDirectoryPath)

IPath.NotEquals(object)

IPath.IsAbsolutePath

IPath.IsRelativePath

IPath.IsEnvVarPath

IPath.IsVariablePath

IPath.IsDirectoryPath

IPath.IsFilePath

IPath.PathMode

IPath.HasParentDirectory

Extension Methods

ExtensionMethodsEnumerable.Concat<TElement>(TElement, IEnumerable<TElement>)

ExtensionMethodsEnumerable.ToEnumerable<TElement>(TElement)

PathHelpers.EqualsNullSupported(IPath, IPath)

PathHelpers.ToStringOrIfNullToEmptyString(IPath)

ExtensionMethodsMisc.ToNullableDouble(object)

Methods (10)

GetBrotherDirectoryWithName(string)

Returns a new directory path prefixed with an environment variable, representing a directory with name directoryName, located in the parent's directory of this directory.

IEnvVarDirectoryPath GetBrotherDirectoryWithName(string directoryName)

Parameters

directoryName string

The brother directory name.

Returns

IEnvVarDirectoryPath

Exceptions

InvalidOperationException

This relative directory path doesn't have a parent directory.

GetBrotherFileWithName(string)

Returns a new file path prefixed with an environment variable, representing a file with name fileName, located in the parent's directory of this directory.

IEnvVarFilePath GetBrotherFileWithName(string fileName)

Parameters

fileName string

The brother file name.

Returns

IEnvVarFilePath

Exceptions

InvalidOperationException

This relative directory path doesn't have a parent directory.

GetChildDirectoryWithName(string)

Returns a new directory path prefixed with an environment variable, representing a directory with name directoryName, located in this directory.

IEnvVarDirectoryPath GetChildDirectoryWithName(string directoryName)

Parameters

directoryName string

The child directory name.

Returns

IEnvVarDirectoryPath

GetChildFileWithName(string)

Returns a new file path prefixed with an environment variable, representing a file with name fileName, located in this directory.

IEnvVarFilePath GetChildFileWithName(string fileName)

Parameters

fileName string

The child file name.

Returns

IEnvVarFilePath

TryGetBrotherDirectoryWithName(string, out IEnvVarDirectoryPath, out string)

Returns true if directoryName doesn't contain forbidden character in path.

bool TryGetBrotherDirectoryWithName(string directoryName, out IEnvVarDirectoryPath directoryPath, out string failureReason)

Parameters

directoryName string

The brother directory name.

directoryPath IEnvVarDirectoryPath

The directory path obtained.

failureReason string

The explanation in case this call returns false.

Returns

bool

TryGetBrotherFileWithName(string, out IEnvVarFilePath, out string)

Returns true if fileName doesn't contain forbidden character in path.

bool TryGetBrotherFileWithName(string fileName, out IEnvVarFilePath filePath, out string failureReason)

Parameters

fileName string

The brother file name.

filePath IEnvVarFilePath

The file path obtained.

failureReason string

The explanation in case this call returns false.

Returns

bool

TryGetChildDirectoryWithName(string, out IEnvVarDirectoryPath, out string)

Returns true if directoryName doesn't contain forbidden character in path.

bool TryGetChildDirectoryWithName(string directoryName, out IEnvVarDirectoryPath directoryPath, out string failureReason)

Parameters

directoryName string

The child directory name.

directoryPath IEnvVarDirectoryPath

The directory path obtained.

failureReason string

The explanation in case this call returns false.

Returns

bool

TryGetChildFileWithName(string, out IEnvVarFilePath, out string)

Returns true if fileName doesn't contain forbidden character in path.

bool TryGetChildFileWithName(string fileName, out IEnvVarFilePath filePath, out string failureReason)

Parameters

fileName string

The child file name.

filePath IEnvVarFilePath

The file path obtained.

failureReason string

The explanation in case this call returns false.

Returns

bool

TryResolve(out IAbsoluteDirectoryPath)

Returns EnvVarPathResolvingStatus.Success if this directory path is prefixed with an environment variable that can be resolved into a drive letter or a UNC absolute directory path.

EnvVarPathResolvingStatus TryResolve(out IAbsoluteDirectoryPath pathDirectoryResolved)

Parameters

pathDirectoryResolved IAbsoluteDirectoryPath

It is the absolute directory path resolved returned by this method.

Returns

EnvVarPathResolvingStatus

TryResolve(out IAbsoluteDirectoryPath, out string)

Returns EnvVarPathResolvingStatus.Success if this directory path is prefixed with an environment variable that can be resolved into a drive letter or a UNC absolute directory path.

bool TryResolve(out IAbsoluteDirectoryPath pathDirectoryResolved, out string failureReason)

Parameters

pathDirectoryResolved IAbsoluteDirectoryPath

It is the absolute directory path resolved returned by this method.

failureReason string

If false is returned, failureReason contains the plain english description of the failure.

Returns

bool