Package com.smartsheet.api.models

Class FolderPathNode

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<java.lang.Long>

com.smartsheet.api.models.PathNode

com.smartsheet.api.models.FolderPathNode

public class FolderPathNode
extends PathNode

Node in a folder path response. Contains recursive folders leading to the target folder.

Constructor Summary

Constructors

Constructor	Description
FolderPathNode()

Method Summary

Modifier and Type	Method	Description
java.util.List<FolderPathNode>	getFolders()
FolderPathNode	getLeafFolder()	Walks down through folders until reaching the deepest (target) folder node, then returns it.
java.lang.String	getLeafFolderPath()	Returns a UNIX style /-joined path of folder names down to the target folder.
FolderPathNode	setFolders(java.util.List<FolderPathNode> folders)

Methods inherited from class com.smartsheet.api.models.PathNode

getAccessLevel, getPermalink, setAccessLevel, setPermalink

Methods inherited from class com.smartsheet.api.models.NamedModel

getName, setName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderPathNode

public FolderPathNode()

Method Detail

getFolders

public java.util.List<FolderPathNode> getFolders()

setFolders

public FolderPathNode setFolders(java.util.List<FolderPathNode> folders)

Parameters:

folders - the list of nested folder nodes; may be null

getLeafFolder

public FolderPathNode getLeafFolder()

Walks down through folders until reaching the deepest (target) folder node, then returns it.

getLeafFolderPath

public java.lang.String getLeafFolderPath()

Returns a UNIX style /-joined path of folder names down to the target folder.

Examples:

• Workspace → FolderA → FolderB → Target returns "/Workspace/FolderA/FolderB/Target"
• Workspace → Target (no intermediate folders) returns "/Workspace/Target"