org.netbeans.modules.java.api.common.ant
Interface UpdateImplementation

public interface UpdateImplementation

Interface that has to be implemented in order to use UpdateHelper. It represents and does the project update process itself.

See Also:

UpdateHelper

Method Summary

boolean	canUpdate() Return true if the project can be updated.
EditableProperties	getUpdatedProjectProperties() Creates probably an in memory update of project properties.
Element	getUpdatedSharedConfigurationData() Creates probably an in memory update of shared configuration data and return it.
boolean	isCurrent() Return true if the project is of current version.
void	saveUpdate(EditableProperties props) Saving of update.

Method Detail

isCurrent

boolean isCurrent()

Return true if the project is of current version.

Returns:

true if the project is of current version.

canUpdate

boolean canUpdate()

Return true if the project can be updated.

Returns:

true if the project can be updated.

saveUpdate

void saveUpdate(EditableProperties props)
                throws IOException

Saving of update. If the project is of current version it should probably do nothing.

Parameters:

props - project properties to be saved, can be null. There's no need to save them because UpdateHelper does it.

Throws:

IOException - if error occurs during saving.

getUpdatedSharedConfigurationData

Element getUpdatedSharedConfigurationData()

Creates probably an in memory update of shared configuration data and return it.

Returns:

the configuration data that is available.

See Also:

UpdateHelper#getPrimaryConfigurationData(boolean)}

getUpdatedProjectProperties

EditableProperties getUpdatedProjectProperties()

Creates probably an in memory update of project properties.

Returns:

a set of properties.

See Also:

UpdateHelper#getProperties(String)}