Interface UploadHook
-
- All Known Implementing Classes:
ApiPreconditionCheckerHook
,DiscardTagsHook
,FixDataHook
,RelationUploadOrderHook
,ValidateUploadHook
public interface UploadHook
Change, or block, the upload. The UploadHook may modify the uploaded data silently, it may display a warning message to the user or prevent the upload altogether. The tags of the changeset can also be changed with modifyChangesetTags method.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default boolean
checkUpload(APIDataSet apiDataSet)
Check, and/or change, the data to be uploaded.default void
modifyChangesetTags(Map<String,String> tags)
Modify the changeset tags (in place) before upload.
-
-
-
Method Detail
-
checkUpload
default boolean checkUpload(APIDataSet apiDataSet)
Check, and/or change, the data to be uploaded. Default implementation is to approve the upload.- Parameters:
apiDataSet
- the data to upload, modify this to change the data.- Returns:
true
if upload is possible,false
to block the upload.
-
modifyChangesetTags
default void modifyChangesetTags(Map<String,String> tags)
Modify the changeset tags (in place) before upload. Default implementation is to do no changes.- Parameters:
tags
- The current tags to change- Since:
- 13028
-
-