NavigateHelper (P4 Plugin 1.15.1 API)

java.lang.Object
- org.jenkinsci.plugins.p4.client.NavigateHelper

All Implemented Interfaces:: Closeable, AutoCloseable

public class NavigateHelper
extends Object
implements Closeable

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NavigateHelper.Node

Constructor Summary

Constructors
Constructor Description

NavigateHelper(int max)

NavigateHelper(com.perforce.p4java.server.IOptionsServer p4)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`AutoCompletionCandidates`	`getCandidates(String depotPath)`	Matches for a partial depot path
`List<NavigateHelper.Node>`	`getNodes(String localPath)`	Get a list of path nodes.

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

- Constructor Detail
  - NavigateHelper
```
public NavigateHelper(com.perforce.p4java.server.IOptionsServer p4)
```
  - NavigateHelper
```
public NavigateHelper(int max)
```
- Method Detail
  - getCandidates
```
public AutoCompletionCandidates getCandidates(String depotPath)
```
    Matches for a partial depot path
    
    Parameters:
    
    depotPath - a Perforce Depot path e.g. //depot/pro
    
    Returns:
    
    matches for the depot path e.g. //depot/projA
  - getNodes
```
public List<NavigateHelper.Node> getNodes(String localPath)
```
    Get a list of path nodes.
    
    Parameters:
    
    localPath - a relative local path e.g. "" for root or "projA/comX"
    
    Returns:
    
    list of nodes
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException