jetbrains.buildServer.serverSide.vcs
Class VcsLabel

java.lang.Object
  extended by jetbrains.buildServer.serverSide.vcs.VcsLabel

public class VcsLabel
extends java.lang.Object

Data object. Contains information about vcs label set for some specified build on the specified vcs root.


Nested Class Summary
static class VcsLabel.VcsLabelStatus
          Presents vcs labeling process status
 
Constructor Summary
VcsLabel(VcsRootInstance root, Build build, VcsLabel.VcsLabelStatus status, java.lang.String labelText, java.lang.String failureReason)
          Creates new vcs label info object.
 
Method Summary
 Build getBuild()
          Build for which the label is set.
 java.lang.String getFailureReason()
          Returns failure reason if set label process failed.
 java.lang.String getLabelText()
          Label value.
 VcsRootInstance getRoot()
          Vcs for for which the label is set.
 VcsLabel.VcsLabelStatus getStatus()
          Set label status.
 java.lang.String getStatusText()
           
 boolean isFailed()
          Returns if labeling process status is failed.
 boolean isSuccessful()
          Returns if labeling process status is successful.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VcsLabel

public VcsLabel(VcsRootInstance root,
                Build build,
                VcsLabel.VcsLabelStatus status,
                java.lang.String labelText,
                java.lang.String failureReason)
Creates new vcs label info object.

Parameters:
root - labeled root.
build - labeled build.
status - labeling process result status.
labelText - label text.
failureReason - null if labeling is successful, failure reason otherwise.
Method Detail

getRoot

public VcsRootInstance getRoot()
Vcs for for which the label is set.

Returns:
label vcs root.

getBuild

public Build getBuild()
Build for which the label is set.

Returns:
build built on sources which were labeled by the label.

getStatus

public VcsLabel.VcsLabelStatus getStatus()
Set label status. Status could be SUCCESSFUL_SET, FAILED, IS_BEING_SET, DISABLED_FOR_THE_ROOT, LABELING_NOT_SUPPORTED.

Returns:
the label current status.

getLabelText

public java.lang.String getLabelText()
Label value.

Returns:
the label string value.

getFailureReason

public java.lang.String getFailureReason()
Returns failure reason if set label process failed.

Returns:
not null reason if labeling process was failed.

isSuccessful

public boolean isSuccessful()
Returns if labeling process status is successful.

Returns:
true is label set successfully, false otherwise.

isFailed

public boolean isFailed()
Returns if labeling process status is failed.

Returns:
true is label set process failed, false otherwise.

getStatusText

public java.lang.String getStatusText()
Returns:
labeling process result status text.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object