com.thoughtworks.go.plugin.api.material.packagerepository

Class PackageRevision

java.lang.Object

com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision

public class PackageRevision
extends Object

Represents specific revision of the package. Package revision consists of revision, timestamp, user, revision comment and addition data. Additional data is key vale map. Each entry added to additional data will be provided to agent as environment variable.

Constructor Summary

Constructors

Constructor and Description
PackageRevision(String revision, Date timestamp, String user)
PackageRevision(String revision, Date timestamp, String user, Map<String,String> data)
PackageRevision(String revision, Date timestamp, String user, String revisionComment, String trackbackUrl)
PackageRevision(String revision, Date timestamp, String user, String revisionComment, String trackbackUrl, Map<String,String> data)

Method Summary

Modifier and Type	Method and Description
void	addData(String key, String value) Adds additional data related to the package revision
boolean	equals(Object o)
Map<String,String>	getData() Gets additional data related to package revision
String	getDataFor(String key) Gets additional data related to package revision for given key
String	getRevision() Gets revision string
String	getRevisionComment() Gets comment associated with revision
Date	getTimestamp() Gets revision timestamp
String	getTrackbackUrl() Gets url which can provide information about producer of package revision
String	getUser() Gets user associated with revision
int	hashCode()
String	toString()
void	validateDataKey(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageRevision

public PackageRevision(String revision,
                       Date timestamp,
                       String user)

PackageRevision

public PackageRevision(String revision,
                       Date timestamp,
                       String user,
                       Map<String,String> data)

PackageRevision

public PackageRevision(String revision,
                       Date timestamp,
                       String user,
                       String revisionComment,
                       String trackbackUrl)

PackageRevision

public PackageRevision(String revision,
                       Date timestamp,
                       String user,
                       String revisionComment,
                       String trackbackUrl,
                       Map<String,String> data)

Method Detail

getRevision

public String getRevision()

Gets revision string

Returns:

revision string

getTimestamp

public Date getTimestamp()

Gets revision timestamp

Returns:

revision timestamp

getUser

public String getUser()

Gets user associated with revision

Returns:

user associated with revision

getRevisionComment

public String getRevisionComment()

Gets comment associated with revision

Returns:

comment associated with revision

getTrackbackUrl

public String getTrackbackUrl()

Gets url which can provide information about producer of package revision

Returns:

url which can provide information about producer of package revision

getData

public Map<String,String> getData()

Gets additional data related to package revision

Returns:

additional data related to package revision

getDataFor

public String getDataFor(String key)

Gets additional data related to package revision for given key

Parameters:

key - for additional data

Returns:

additional data related to package revision for given key

addData

public void addData(String key,
                    String value)
             throws InvalidPackageRevisionDataException

Adds additional data related to the package revision

Parameters:

key - for additional data

value - for additional data

Throws:

InvalidPackageRevisionDataException - if the key is null or empty

validateDataKey

public void validateDataKey(String key)
                     throws InvalidPackageRevisionDataException

Throws:

InvalidPackageRevisionDataException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object