com.offbytwo.jenkins.model

Class FolderJob

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Job

com.offbytwo.jenkins.model.FolderJob

public class FolderJob
extends Job

Field Summary

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
FolderJob()
FolderJob(String name, String url)

Method Summary

Modifier and Type	Method and Description
void	createFolder(String folderName) Create a folder on the server (as a subfolder of this folder)
void	createFolder(String folderName, Boolean crumbFlag) Create a folder on the server (as a subfolder of this folder)
String	getDisplayName()
Job	getJob(String name) Get a job in this folder by name
Map<String,Job>	getJobs() Get a list of all the defined jobs in this folder
boolean	isFolder() Determine if this FolderJob object is a valid folder or not.

Methods inherited from class com.offbytwo.jenkins.model.Job

build, build, build, build, details, equals, getFileFromWorkspace, getName, getUrl, hashCode

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

get_class, getClient, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderJob

public FolderJob()

FolderJob

public FolderJob(String name,
                 String url)

Method Detail

getDisplayName

public String getDisplayName()

isFolder

public boolean isFolder()

Determine if this FolderJob object is a valid folder or not. (internally: if jobs list exists)

Returns:

true if this job is a folder.

getJobs

public Map<String,Job> getJobs()

Get a list of all the defined jobs in this folder

Returns:

list of defined jobs (summary level, for details @see Job#details

getJob

public Job getJob(String name)

Get a job in this folder by name

Parameters:

name - the name of the job.

Returns:

the given job

createFolder

public void createFolder(String folderName)
                  throws IOException

Create a folder on the server (as a subfolder of this folder)

Parameters:

folderName - name of the folder to be created.

Throws:

IOException - in case of an error.

createFolder

public void createFolder(String folderName,
                         Boolean crumbFlag)
                  throws IOException

Create a folder on the server (as a subfolder of this folder)

Parameters:

folderName - name of the folder to be created.

crumbFlag - true/false.

Throws:

IOException - in case of an error.