Constructor Detail

• Member

  public Member(com.mks.api.response.WorkItem wi,
        String configPath,
        String projectRoot,
        String workspaceDir)

  This class represents an MKS Integrity Source File It needs the Member Name (relative path to pj), Full Member Path, Project Configuration Path, Revision, Project's Root Path, and the current Workspace directory (to compute the working file path) for its instantiation. This helper class will be used to then perform a project checkout from the repository

  Parameters:

  wi - A MKS API Response Work Item representing metadata related to a Integrity Member

  configPath - Configuration Path for this file's project/subproject

  projectRoot - Full path to the root location for this file's parent project

  workspaceDir - Full path to the workspace root directory

Method Detail

• getTargetFilePath

  public String getTargetFilePath()

  Returns a string representation of this file's full path name, where it will checked out to disk for the build.

  Returns:

• getRevision

  public String getRevision()

  Returns a string representation of this member's revision

  Returns:

• getTimestamp

  public Date getTimestamp()

  Returns the date/time associated with this member revision

  Returns:

• getDescription

  public String getDescription()

  Returns any check-in comments associated with this revision

  Returns:

• getMemberName

  public String getMemberName()

  Returns the full server-side member path for this member

  Returns:

• getName

  public String getName()

  Returns only the file name portion for this full server-side member path

  Returns:

• setLineTerminator

  public void setLineTerminator(String lineTerminator)

  Optionally, one may set a line terminator, if the default is not desired.

  Parameters:

  lineTerminator -

• setOverwriteExisting

  public void setOverwriteExisting(String overwriteExisting)

  Optionally, one may choose not to overwrite existing files, this may speed up the synchronization process.

  Parameters:

  overwriteExisting -

• setRestoreTimestamp

  public void setRestoreTimestamp(boolean restoreTime)

  Optionally, one might want to restore the timestamp, if the build is smart not to recompile files that were not touched.

  Parameters:

  restoreTimestamp -

• checkout

  public boolean checkout(APISession api)
                   throws com.mks.api.response.APIException

  Performs a checkout of this MKS Integrity Source File to a working file location on the build server represented by targetFile

  Parameters:

  api - MKS API Session

  Returns:

  true if the operation succeeded or false if failed

  Throws:

  com.mks.api.response.APIException

• equals

  public boolean equals(Object o)

  Uses the name of file for equality check

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object