UniformPath (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.uniformpath.UniformPath

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UniformPath>
```
public final class UniformPath
extends java.lang.Object
implements java.lang.Comparable<UniformPath>, java.io.Serializable
```
An absolute uniform path with a specific type, where type might be something like "code", "non-code" or "architecture" (see UniformPath.EType). Never includes a project or repository name. Use UniformPathCompatibilityUtil to create UniformPath instances from String representations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UniformPath.EType
All types a path can have.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UniformPath.EType` All types a path can have.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`SEGMENTS_PROPERTY` The name of the JSON property name for `segments`.
`protected static java.lang.String`	`TYPE_PROPERTY` The name of the JSON property name for `type`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UniformPath`	`codeRoot()` Returns the code type root path.
`int`	`compareTo(UniformPath other)`
`boolean`	`equals(java.lang.Object obj)`
`static java.lang.String`	`escapeSegment(java.lang.String segment)` Escapes uniform path separators in a segment.
`java.lang.String`	`getLastSegment()` Returns the name of the last segment (directory or file) of this path.
`UniformPath`	`getParent()` Returns the parent of this path, i.e.
`RelativeUniformPath`	`getSubPath(int numberOfTopLevelSegmentsToRemove)` Returns the sub path relative to the given number of top level path segments.
`RelativeUniformPath`	`getSubPathAfter(java.lang.String segment)` Returns the relative sub path after the given segment.
`boolean`	`hasAncestor(UniformPath ancestorPath)` Returns whether the ancestorPath contains this path as a subpath.
`boolean`	`hasDescendant(UniformPath descendantPath)` Returns whether this path contains the descendantPath as a subpath.
`int`	`hashCode()`
`boolean`	`isArchitecturePath()` Returns whether this path is an architecture path
`boolean`	`isCodePath()` Returns whether this path is a (regular) code path
`boolean`	`isIssuePath()` Returns whether this path is an issue path
`boolean`	`isNonCodePath()` Returns whether this path is a non-code path
`boolean`	`isRoot()` Returns whether this is a root path.
`boolean`	`isTestPath()` Returns whether this path is a test execution path
`static boolean`	`isValidPath(java.lang.String uniformPath)` Checks whether the given uniform path is valid or not.
`static UniformPath`	`of(java.util.List<java.lang.String> segments)` Builds a path from the given segments.
`static UniformPath`	`of(java.lang.String... segments)` Builds a path from the given segments.
`static UniformPath`	`of(UniformPath.EType type, java.util.List<java.lang.String> segments)` Builds a path from the given segments.
`static UniformPath`	`of(UniformPath.EType type, java.lang.String... segments)` Builds a path from the given segments.
`UniformPath`	`resolve(RelativeUniformPath relativePath)` Resolves the given relative path against this absolute path, performing path canonicalization in the process (i.e.
`static UniformPath`	`testRoot()` Returns the test type root path.
`java.lang.String`	`toString()`
`java.lang.String`	`urlEncode()` Returns this uniform path in url encoding (as needed for safely using it in teamscale URLs).

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_PROPERTY
```
protected static final java.lang.String TYPE_PROPERTY
```
    The name of the JSON property name for type.
    
    See Also:
    
    Constant Field Values
  - SEGMENTS_PROPERTY
```
protected static final java.lang.String SEGMENTS_PROPERTY
```
    The name of the JSON property name for segments.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - of
```
public static UniformPath of(java.lang.String... segments)
```
    Builds a path from the given segments. The segments must consist of non-empty strings that are not just relative paths (e.g. "." or "..") and may not contain unescaped slashes ("/").
    
    See Also:
    
    of(List)
  - of
```
public static UniformPath of(UniformPath.EType type,
                             java.lang.String... segments)
```
    Builds a path from the given segments. The segments must consist of non-empty strings that are not just relative paths (e.g. "." or "..") and may not contain unescaped slashes ("/").
    
    See Also:
    
    of(List)
  - of
```
public static UniformPath of(UniformPath.EType type,
                             java.util.List<java.lang.String> segments)
```
    Builds a path from the given segments. The segments must consist of non-empty strings that are not just relative paths (e.g. "." or "..") and may not contain unescaped slashes ("/"). The result is ensured to be of the given type so the according prefix may be present, but does not have to. If the uniform path is of a different type an assertion error is thrown.
    
    See Also:
    
    of(List)
  - of
```
public static UniformPath of(java.util.List<java.lang.String> segments)
```
    Builds a path from the given segments. The segments must consist of non-empty strings that are not just relative paths (e.g. "." or "..") and may not contain unescaped slashes ("/").
  - codeRoot
```
public static UniformPath codeRoot()
```
    Returns the code type root path.
  - testRoot
```
public static UniformPath testRoot()
```
    Returns the test type root path.
  - escapeSegment
```
public static java.lang.String escapeSegment(java.lang.String segment)
```
    Escapes uniform path separators in a segment.
  - getParent
```
public UniformPath getParent()
```
    Returns the parent of this path, i.e. a new uniform path without the last segment of this path.
  - getLastSegment
```
public java.lang.String getLastSegment()
```
    Returns the name of the last segment (directory or file) of this path.
  - getSubPath
```
public RelativeUniformPath getSubPath(int numberOfTopLevelSegmentsToRemove)
```
    Returns the sub path relative to the given number of top level path segments. In other words: Remove the given number of top level elements from the path.
    Example: Removing two segments from src/main/java/Class.java will yield the relative path java/Class.java.
  - getSubPathAfter
```
public RelativeUniformPath getSubPathAfter(java.lang.String segment)
```
    Returns the relative sub path after the given segment.
    Example: The subpath after java in src/main/java/Class.java will yield the relative path Class.java.
  - isValidPath
```
public static boolean isValidPath(java.lang.String uniformPath)
```
    Checks whether the given uniform path is valid or not.
  - isRoot
```
public boolean isRoot()
```
    Returns whether this is a root path. Note that there can be multiple root paths, depending on the type (i.e. "-architecture-" and "-non-code-" are both root paths. The path "/" is expanded to "-code-" and is also a root path).
  - isCodePath
```
public boolean isCodePath()
```
    Returns whether this path is a (regular) code path
  - isNonCodePath
```
public boolean isNonCodePath()
```
    Returns whether this path is a non-code path
  - isArchitecturePath
```
public boolean isArchitecturePath()
```
    Returns whether this path is an architecture path
  - isIssuePath
```
public boolean isIssuePath()
```
    Returns whether this path is an issue path
  - isTestPath
```
public boolean isTestPath()
```
    Returns whether this path is a test execution path
  - resolve
```
public UniformPath resolve(RelativeUniformPath relativePath)
```
    Resolves the given relative path against this absolute path, performing path canonicalization in the process (i.e. ".." will be resolved to parent segment).
  - hasAncestor
```
public boolean hasAncestor(UniformPath ancestorPath)
```
    Returns whether the ancestorPath contains this path as a subpath. Example: src is an ancestor of src/main.
  - hasDescendant
```
public boolean hasDescendant(UniformPath descendantPath)
```
    Returns whether this path contains the descendantPath as a subpath. Example: /src/main is a descendant of /src.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - compareTo
```
public int compareTo(UniformPath other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<UniformPath>
  - urlEncode
```
public java.lang.String urlEncode()
```
    Returns this uniform path in url encoding (as needed for safely using it in teamscale URLs). For example, '/' is replaced by "%2F", '@' is replaced by "%40", and so on.

Class UniformPath

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_PROPERTY

SEGMENTS_PROPERTY

Method Detail

of

of

of

of

codeRoot

testRoot

escapeSegment

getParent

getLastSegment

getSubPath

getSubPathAfter

isValidPath

isRoot

isCodePath

isNonCodePath

isArchitecturePath

isIssuePath

isTestPath

resolve

hasAncestor

hasDescendant

toString

hashCode

equals

compareTo

urlEncode