Top Description Inners Fields Constructors Methods
org.eclipse.jgit.api

public Class CheckoutResult

extends Object
Class Inheritance
Imports
java.util.ArrayList, .List
Encapsulates the result of a org.eclipse.jgit.api.CheckoutCommand

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
CheckoutResult.Status

The status

Field Summary

Modifier and TypeField and Description
private final List<String>
conflictList

public static final CheckoutResult
ERROR_RESULT

The Status#ERROR result;

private final List<String>
modifiedList

private final CheckoutResult.Status
myStatus

public static final CheckoutResult
NOT_TRIED_RESULT

The Status#NOT_TRIED result;

private final List<String>
removedList

private final List<String>
undeletedList

Constructor Summary

AccessConstructor and Description
pack-priv
CheckoutResult(CheckoutResult.Status
the failure status
status, List<String>
the list of files to store, status has to be either Status#CONFLICTS or Status#NONDELETED.
fileList)

Create a new fail result.

pack-priv
CheckoutResult(CheckoutResult.Status
the failure status
status, List<String>
the list of files to store, status has to be either Status#CONFLICTS or Status#NONDELETED.
fileList, List<String>
the modified files
modified, List<String>
the removed files.
removed)

Create a new fail result.

pack-priv
CheckoutResult(List<String>
the modified files
modified, List<String>
the removed files.
removed)

Create a new OK result with modified and removed files.

Method Summary

Modifier and TypeMethod and Description
public List<String>

Returns:

the list of files that created a checkout conflict, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#CONFLICTS;
getConflictList()

Get list of file that created a checkout conflict

public List<String>

Returns:

the list of files that where modified during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#OK
getModifiedList()

Get the list of files that where modified during checkout

public List<String>

Returns:

the list of files that where removed during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#OK
getRemovedList()

Get the list of files that where removed during checkout

public CheckoutResult.Status

Returns:

the status
getStatus()

Get status

public List<String>

Returns:

the list of files that could not be deleted during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#NONDELETED;
getUndeletedList()

Get the list of files that could not be deleted during checkout

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

conflictListback to summary
private final List<String> conflictList
ERROR_RESULTback to summary
public static final CheckoutResult ERROR_RESULT

The Status#ERROR result;

modifiedListback to summary
private final List<String> modifiedList
myStatusback to summary
private final CheckoutResult.Status myStatus
NOT_TRIED_RESULTback to summary
public static final CheckoutResult NOT_TRIED_RESULT

The Status#NOT_TRIED result;

removedListback to summary
private final List<String> removedList
undeletedListback to summary
private final List<String> undeletedList

Constructor Detail

CheckoutResultback to summary
pack-priv CheckoutResult(CheckoutResult.Status status, List<String> fileList)

Create a new fail result. If status is Status#CONFLICTS, fileList is a list of conflicting files, if status is Status#NONDELETED, fileList is a list of not deleted files. All other values ignore fileList. To create a result for Status#OK, see CheckoutResult(List, List).

Parameters
status:CheckoutResult.Status

the failure status

fileList:List<String>

the list of files to store, status has to be either Status#CONFLICTS or Status#NONDELETED.

CheckoutResultback to summary
pack-priv CheckoutResult(CheckoutResult.Status status, List<String> fileList, List<String> modified, List<String> removed)

Create a new fail result. If status is Status#CONFLICTS, fileList is a list of conflicting files, if status is Status#NONDELETED, fileList is a list of not deleted files. All other values ignore fileList. To create a result for Status#OK, see CheckoutResult(List, List).

Parameters
status:CheckoutResult.Status

the failure status

fileList:List<String>

the list of files to store, status has to be either Status#CONFLICTS or Status#NONDELETED.

modified:List<String>

the modified files

removed:List<String>

the removed files.

CheckoutResultback to summary
pack-priv CheckoutResult(List<String> modified, List<String> removed)

Create a new OK result with modified and removed files.

Parameters
modified:List<String>

the modified files

removed:List<String>

the removed files.

Method Detail

getConflictListback to summary
public List<String> getConflictList()

Get list of file that created a checkout conflict

Returns:List<String>

the list of files that created a checkout conflict, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#CONFLICTS;

getModifiedListback to summary
public List<String> getModifiedList()

Get the list of files that where modified during checkout

Returns:List<String>

the list of files that where modified during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#OK

getRemovedListback to summary
public List<String> getRemovedList()

Get the list of files that where removed during checkout

Returns:List<String>

the list of files that where removed during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#OK

getStatusback to summary
public CheckoutResult.Status getStatus()

Get status

Returns:CheckoutResult.Status

the status

getUndeletedListback to summary
public List<String> getUndeletedList()

Get the list of files that could not be deleted during checkout

Returns:List<String>

the list of files that could not be deleted during checkout, or an empty list if getStatus() is not org.eclipse.jgit.api.CheckoutResult.Status#NONDELETED;

org.eclipse.jgit.api back to summary

public final Enum CheckoutResult.Status

extends Enum<CheckoutResult.Status>
Class Inheritance
The status

Field Summary

Modifier and TypeField and Description
public static final CheckoutResult.Status
CONFLICTS

Checkout has not completed because of checkout conflicts

public static final CheckoutResult.Status
ERROR

An Exception occurred during checkout

public static final CheckoutResult.Status
NONDELETED

Checkout has completed, but some files could not be deleted

public static final CheckoutResult.Status
NOT_TRIED

The call() method has not yet been executed

public static final CheckoutResult.Status
OK

Checkout completed normally

Constructor Summary

AccessConstructor and Description
private
Status()

Method Summary

Modifier and TypeMethod and Description
public static CheckoutResult.Status
valueOf(String name)

public static CheckoutResult.Status[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CONFLICTSback to summary
public static final CheckoutResult.Status CONFLICTS

Checkout has not completed because of checkout conflicts

ERRORback to summary
public static final CheckoutResult.Status ERROR

An Exception occurred during checkout

NONDELETEDback to summary
public static final CheckoutResult.Status NONDELETED

Checkout has completed, but some files could not be deleted

NOT_TRIEDback to summary
public static final CheckoutResult.Status NOT_TRIED

The call() method has not yet been executed

OKback to summary
public static final CheckoutResult.Status OK

Checkout completed normally

Constructor Detail

Statusback to summary
private Status()

Method Detail

valueOfback to summary
public static CheckoutResult.Status valueOf(String name)
valuesback to summary
public static CheckoutResult.Status[] values()