Package org.craftercms.deployer.api

Class ChangeSet

java.lang.Object

org.craftercms.search.batch.AbstractUpdateDetailProvider

org.craftercms.deployer.api.ChangeSet

All Implemented Interfaces:

org.craftercms.search.batch.UpdateDetailProvider

public class ChangeSet
extends org.craftercms.search.batch.AbstractUpdateDetailProvider

The collection of created, updated and deleted files that have been changed in a deployment.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	createdFiles
protected List<String>	deletedFiles
protected List<String>	updatedFiles

Fields inherited from class org.craftercms.search.batch.AbstractUpdateDetailProvider

updateDetails, updateLog

Constructor Summary

Constructors

Constructor	Description
ChangeSet()
ChangeSet(List<String> createdFiles, List<String> updatedFiles, List<String> deletedFiles)

Method Summary

Modifier and Type	Method	Description
void	addCreatedFile(String file)	Adds a file to the list of created files if it's not in the list
void	addDeletedFile(String file)	Adds a file to the list of deleted files if it's not in the list
void	addUpdatedFile(String file)	Adds a file to the list of updated files if it's not in the list
List<String>	getCreatedFiles()	Returns the list of created files.
List<String>	getDeletedFiles()	Returns the list of deleted files.
List<String>	getUpdatedFiles()	Returns the list of updated files.
boolean	isEmpty()	Returns true if there are not created, updated or deleted files.
void	removeCreatedFile(String file)	Removes a file from the list of created files.
void	removeDeletedFile(String file)	Removes a file from the list of deleted files.
void	removeUpdatedFile(String file)	Removes a file from the list of updated files.

Methods inherited from class org.craftercms.search.batch.AbstractUpdateDetailProvider

getUpdateDetail, getUpdateDetails, getUpdateLog, setUpdateDetails, setUpdateLog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

createdFiles

protected List<String> createdFiles

updatedFiles

protected List<String> updatedFiles

deletedFiles

protected List<String> deletedFiles

Constructor Detail

ChangeSet

public ChangeSet()

ChangeSet

public ChangeSet(List<String> createdFiles,
                 List<String> updatedFiles,
                 List<String> deletedFiles)

Method Detail

getCreatedFiles

public List<String> getCreatedFiles()

Returns the list of created files.

addCreatedFile

public void addCreatedFile(String file)

Adds a file to the list of created files if it's not in the list

Parameters:

file - the file to add

removeCreatedFile

public void removeCreatedFile(String file)

Removes a file from the list of created files.

Parameters:

file - the file to remove

getUpdatedFiles

public List<String> getUpdatedFiles()

Returns the list of updated files.

addUpdatedFile

public void addUpdatedFile(String file)

Adds a file to the list of updated files if it's not in the list

Parameters:

file - the file to add

removeUpdatedFile

public void removeUpdatedFile(String file)

Removes a file from the list of updated files.

Parameters:

file - the file to remove

getDeletedFiles

public List<String> getDeletedFiles()

Returns the list of deleted files.

addDeletedFile

public void addDeletedFile(String file)

Adds a file to the list of deleted files if it's not in the list

Parameters:

file - the file to add

removeDeletedFile

public void removeDeletedFile(String file)

Removes a file from the list of deleted files.

Parameters:

file - the file to remove

isEmpty

public boolean isEmpty()

Returns true if there are not created, updated or deleted files.