org.electrocodeogram.cpc.core.api.provider.cpcrepository
Interface ICPCRevision

public interface ICPCRevision

A ICPCRevision is a simple wrapper object for remotely stored clone data packages.
It contains:

• a revision id string
• an ICloneFile instance
• a list of IClone instances for the file

ICPCRevision instances are used in combination with ICPCRepositoryProvider operations.
A new instance for this interface can be obtained via: ICPCRepositoryProvider.createRevision()

Author:

vw

See Also:

ICPCRepositoryProvider

Method Summary

ICloneFile	getCloneFile() Retrieves the ICloneFile instance for this cpc revision.
java.util.List<IClone>	getClones() Retries a list of IClone instances which are part of this revision.
java.lang.String	getRevisionId() Retrieves the revision identifier string for this cpc revision.
boolean	isValid() Checks whether all required fields for this element have been set.
void	setCloneFile(ICloneFile cloneFile) Sets the ICloneFile instance for this cpc revision.
void	setClones(java.util.List<IClone> clones) Specifies a list of IClone instances which are part of this revision.
void	setRevisionId(java.lang.String revisionId) Sets the revision identifier string for this cpc revision.
java.lang.String	toString() All implementations should provide a meaningful toString() method for debugging purposes.

Method Detail

getRevisionId

java.lang.String getRevisionId()

Retrieves the revision identifier string for this cpc revision.
I.e. a revision identifier as it is assigned to source files from the main source repository provider.

Returns:

revision identifier, never null.

setRevisionId

void setRevisionId(java.lang.String revisionId)

Sets the revision identifier string for this cpc revision.

Parameters:

revisionId - revision identifier, never null.

See Also:

getRevisionId()

getCloneFile

ICloneFile getCloneFile()

Retrieves the ICloneFile instance for this cpc revision.

Returns:

an ICloneFile instance, never null.

setCloneFile

void setCloneFile(ICloneFile cloneFile)

Sets the ICloneFile instance for this cpc revision.

Parameters:

cloneFile - an ICloneFile instance, never null.

See Also:

getCloneFile()

getClones

java.util.List<IClone> getClones()

Retries a list of IClone instances which are part of this revision.
They are all located with the getCloneFile() file.

Returns:

a list of IClone for this file, never null.

setClones

void setClones(java.util.List<IClone> clones)

Specifies a list of IClone instances which are part of this revision.

Parameters:

clones - a list of IClone for this file, never null.

See Also:

getClones()

isValid

boolean isValid()

Checks whether all required fields for this element have been set.

Returns:

true if all required fields have been set, false otherwise.

toString

java.lang.String toString()

All implementations should provide a meaningful toString() method for debugging purposes.

Overrides:

toString in class java.lang.Object