SimplePath (Bitbucket Server

java.lang.Object
- com.atlassian.bitbucket.content.SimplePath

All Implemented Interfaces:: Path, Serializable, Comparable<SimplePath>

public class SimplePath
extends Object
implements Comparable<SimplePath>, Path, Serializable

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String[] EMPTY

static SimplePath ROOT

Fields
Modifier and Type	Field and Description
`static String[]`	`EMPTY`
`static SimplePath`	`ROOT`

Constructor Summary

Constructors
Constructor and Description
`SimplePath(CharSequence path)`
`SimplePath(CharSequence path, boolean allowSloshes)`
`SimplePath(List<String> start)`
`SimplePath(Path path)`
`SimplePath(SimplePath aParent, SimplePath aPath)`
`SimplePath(SimplePath aParent, String... aPath)`
`SimplePath(SimplePath aParent, String aPath)`
`SimplePath(SimplePath aParent, String aPath, boolean allowSloshes)`
`SimplePath(String aParent, SimplePath aPath)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimplePath`	`abbreviate(int maxLength)` Abbreviates the path by removing path components from the middle until the length of the `path` is not greater than `maxLength`.
`SimplePath[]`	`abbreviatePathComponents(int maxLength)` Returns a similar result to `getPathComponents()`, but abbreviates the result (inserts null at the break point)
`int`	`compareTo(SimplePath o)`
`boolean`	`equals(Object o)`
`SimplePath`	`getCommonRoot(SimplePath other)`
`String`	`getComponent(int i)`
`String[]`	`getComponents()`
`String`	`getExtension()`
`String`	`getName()`
`int`	`getNumComponents()`
`String`	`getParent()`
`SimplePath`	`getParentPath()`
`String`	`getPath()`
`String`	`getPath(boolean caseSensitive)`
`SimplePath[]`	`getPathComponents()`
`SimplePath`	`getPathHead()`
`SimplePath`	`getStripTail(SimplePath other, boolean caseSensitive)` if other is an exact tail of this, return the path leading up to that tail otherwise return null
`SimplePath`	`getSubPath(int depth)`
`String`	`getTail()`
`SimplePath`	`getTailPath()`
`int`	`hashCode()`
`boolean`	`hasPrefix(SimplePath p)` determines if this path begins with all of `p`
`boolean`	`hasPrefix(SimplePath p, boolean caseSensitive)`
`boolean`	`isAncestor(SimplePath descendant)`
`boolean`	`isRoot()`
`static String`	`join(String a, String b)` Intelligently put a "/" between two strings.
`SimplePath`	`simplify()`
`static String[]`	`split(CharSequence aPath)`
`static String[]`	`split(CharSequence aPath, boolean allowSloshes)`
`String`	`toString()`
`SimplePath`	`trimFirst()`
`SimplePath`	`trimFirst(int n)`
`SimplePath`	`trimLast()`

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

- Field Detail
  - EMPTY
```
public static final String[] EMPTY
```
  - ROOT
```
public static final SimplePath ROOT
```
- Constructor Detail
  - SimplePath
```
public SimplePath(Path path)
```
  - SimplePath
```
public SimplePath(CharSequence path)
```
  - SimplePath
```
public SimplePath(CharSequence path,
                  boolean allowSloshes)
```
  - SimplePath
```
public SimplePath(SimplePath aParent,
                  String aPath)
```
  - SimplePath
```
public SimplePath(SimplePath aParent,
                  String... aPath)
```
  - SimplePath
```
public SimplePath(SimplePath aParent,
                  SimplePath aPath)
```
  - SimplePath
```
public SimplePath(SimplePath aParent,
                  String aPath,
                  boolean allowSloshes)
```
  - SimplePath
```
public SimplePath(String aParent,
                  SimplePath aPath)
```
  - SimplePath
```
public SimplePath(List<String> start)
```
- Method Detail
  - join
```
public static String join(String a,
                          String b)
```
    Intelligently put a "/" between two strings.
    
    Parameters:
    
    a - first path component
    
    b - second path component
    
    Returns:
    
    merged path
  - split
```
public static String[] split(CharSequence aPath)
```
  - split
```
public static String[] split(CharSequence aPath,
                             boolean allowSloshes)
```
  - abbreviate
```
public SimplePath abbreviate(int maxLength)
```
    Abbreviates the path by removing path components from the middle until the length of the path is not greater than maxLength.
    The first and last path component are always in the returned path. If any path components are removed, an ellipses ("...") will appear in the middle. The returned path may in some cases still be greater than the specified maxLength.
    
    Parameters:
    
    maxLength - maximum number of characters
    
    Returns:
    
    an abbreviated path
  - abbreviatePathComponents
```
public SimplePath[] abbreviatePathComponents(int maxLength)
```
    Returns a similar result to getPathComponents(), but abbreviates the result (inserts null at the break point)
    
    Parameters:
    
    maxLength - maximum length
    
    Returns:
    
    an abbreviated array of path components for the current path
  - compareTo
```
public int compareTo(SimplePath o)
```
    Specified by:
    
    compareTo in interface Comparable<SimplePath>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getCommonRoot
```
public SimplePath getCommonRoot(SimplePath other)
```
  - getComponent
```
public String getComponent(int i)
```
  - getComponents
```
@Nonnull
public String[] getComponents()
```
    Specified by:
    
    getComponents in interface Path
    
    Returns:
    
    an array of Strings representing the directories followed by a possible file name
  - getExtension
```
public String getExtension()
```
    Specified by:
    
    getExtension in interface Path
    
    Returns:
    
    the file extension of the path (with no .), or null if there is no file extension
  - getName
```
@Nonnull
public String getName()
```
    Specified by:
    
    getName in interface Path
    
    Returns:
    
    everything after the last "/" (the last component), including the extension, or an empty string if there are no components
  - getNumComponents
```
public int getNumComponents()
```
  - getParent
```
public String getParent()
```
    Specified by:
    
    getParent in interface Path
    
    Returns:
    
    the parent string - everything up to the last component, or an empty string if root
  - getParentPath
```
public SimplePath getParentPath()
```
  - getPath
```
public String getPath()
```
    Returns:
    
    the string representation of the path
  - getPath
```
public String getPath(boolean caseSensitive)
```
  - getPathComponents
```
public SimplePath[] getPathComponents()
```
  - getPathHead
```
public SimplePath getPathHead()
```
  - getStripTail
```
public SimplePath getStripTail(SimplePath other,
                               boolean caseSensitive)
```
    if other is an exact tail of this, return the path leading up to that tail otherwise return null
    
    Parameters:
    
    other - the other path
    
    caseSensitive - true if case sensitive
    
    Returns:
    
    the stripped path, or null if the other path is not a tail of this path
  - getSubPath
```
public SimplePath getSubPath(int depth)
```
  - getTail
```
public String getTail()
```
    Returns:
    
    a String composed of all the path segments after the first segment
  - getTailPath
```
public SimplePath getTailPath()
```
  - hasPrefix
```
public boolean hasPrefix(SimplePath p)
```
    determines if this path begins with all of p
    
    Parameters:
    
    p - the prefix to check
    
    Returns:
    
    true if it has the prefix path
  - hasPrefix
```
public boolean hasPrefix(SimplePath p,
                         boolean caseSensitive)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isAncestor
```
public boolean isAncestor(SimplePath descendant)
```
  - isRoot
```
public boolean isRoot()
```
  - simplify
```
public SimplePath simplify()
```
  - toString
```
@Nonnull
public String toString()
```
    Specified by:
    
    toString in interface Path
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the path - the components separated by "/"s
  - trimFirst
```
public SimplePath trimFirst()
```
  - trimFirst
```
public SimplePath trimFirst(int n)
```
    Parameters:
    
    n - number of components to trim
    
    Returns:
    
    the trimmed path or same path if the length was 0
  - trimLast
```
public SimplePath trimLast()
```

Class SimplePath

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

ROOT

Constructor Detail

SimplePath

SimplePath

SimplePath

SimplePath

SimplePath

SimplePath

SimplePath

SimplePath

SimplePath

Method Detail

join

split

split

abbreviate

abbreviatePathComponents

compareTo

equals

getCommonRoot

getComponent

getComponents

getExtension

getName

getNumComponents

getParent

getParentPath

getPath

getPath

getPathComponents

getPathHead

getStripTail

getSubPath

getTail

getTailPath

hasPrefix

hasPrefix

hashCode

isAncestor

isRoot

simplify

toString

trimFirst

trimFirst

trimLast