org.apache.ivy.core.publish

Class PublishOptions

public class PublishOptions extends Object

A set of options used during publish related tasks The publish can update the ivy file to publish if update is set to true. In this case it will use the given pubrevision, pubdate and status. If pudate is null it will default to the current date. If status is null it will default to the current ivy file status (which itself defaults to integration if none is found). If update is false, then if the revision is not the same in the ivy file than the one expected (given as parameter), this method will fail with an IllegalArgumentException. pubdate and status are not used if update is false. extra artifacts can be used to publish more artifacts than actually declared in the ivy file. This can be useful to publish additional metadata or reports. The extra artifacts array can be null (= no extra artifacts), and if non null only the name, type, ext url and extra attributes of the artifacts are really used. Other methods (on the artifacts) can return null safely.

See Also: PublishEngine

Method Summary
String[]getConfs()
Artifact[]getExtraArtifacts()
StringgetPubBranch()
DategetPubdate()
StringgetPubrevision()
StringgetSrcIvyPattern()
StringgetStatus()
booleanisHaltOnMissing()
booleanisOverwrite()
booleanisUpdate()
booleanisValidate()
booleanisWarnOnMissing()
PublishOptionssetConfs(String[] confs)
PublishOptionssetExtraArtifacts(Artifact[] extraArtifacts)
PublishOptionssetHaltOnMissing(boolean haltonmissing)
PublishOptionssetOverwrite(boolean overwrite)
PublishOptionssetPubbranch(String pubbranch)
PublishOptionssetPubdate(Date pubdate)
PublishOptionssetPubrevision(String pubrevision)
PublishOptionssetSrcIvyPattern(String srcIvyPattern)
PublishOptionssetStatus(String status)
PublishOptionssetUpdate(boolean update)
PublishOptionssetValidate(boolean validate)
PublishOptionssetWarnOnMissing(boolean warnonmissing)

Method Detail

getConfs

public String[] getConfs()

getExtraArtifacts

public Artifact[] getExtraArtifacts()

getPubBranch

public String getPubBranch()

getPubdate

public Date getPubdate()

getPubrevision

public String getPubrevision()

getSrcIvyPattern

public String getSrcIvyPattern()

getStatus

public String getStatus()

isHaltOnMissing

public boolean isHaltOnMissing()

isOverwrite

public boolean isOverwrite()

isUpdate

public boolean isUpdate()

isValidate

public boolean isValidate()

isWarnOnMissing

public boolean isWarnOnMissing()

setConfs

public PublishOptions setConfs(String[] confs)

setExtraArtifacts

public PublishOptions setExtraArtifacts(Artifact[] extraArtifacts)

setHaltOnMissing

public PublishOptions setHaltOnMissing(boolean haltonmissing)

setOverwrite

public PublishOptions setOverwrite(boolean overwrite)

setPubbranch

public PublishOptions setPubbranch(String pubbranch)

setPubdate

public PublishOptions setPubdate(Date pubdate)

setPubrevision

public PublishOptions setPubrevision(String pubrevision)

setSrcIvyPattern

public PublishOptions setSrcIvyPattern(String srcIvyPattern)

setStatus

public PublishOptions setStatus(String status)

setUpdate

public PublishOptions setUpdate(boolean update)

setValidate

public PublishOptions setValidate(boolean validate)

setWarnOnMissing

public PublishOptions setWarnOnMissing(boolean warnonmissing)