tree 6151593958f8d99e8f8330446c5e2e38628dc3ec
parent a80abbea1d8504b367718a906e778b6a1835dfe7
author Edwin Kempin <ekempin@google.com> 1530536202 +0200
committer Edwin Kempin <ekempin@google.com> 1530600302 +0200

Fix JavaDoc of AcceptsDelete

From the JavaDoc it is unclear what's the purpose of this interface. Its
class level JavaDoc says that it's to handle DELETE requests on the
RestCollection itself, but its apply method says it's for deleting a
member of the collection and hence for handling DELETE requests on a
member.

The truth is that this interface is used for two cases:

1. handling DELETE requests on the RestCollection (actually this
   functionaly seems to be unused, but RestApiServlet supports it)
2. handling DELETE requests on non-existing members of the
   RestCollection (in order to create that member)

Generally AcceptsDelete is not supported on root collections (because
support for it is not implemented in RestApiServlet).

Using this interface for two different purposes is a mess and creating
non-existing members of a collection by a DELETE request is strange (but
intended by change Ieeb15d0a91), but since I spent quite some time to
figure out how it works and what it is used for (change edits) I thought
I should at least write my findings into the JavaDoc.

Change-Id: Iaa9559cd775ee51c2b1066ede4107dd9978e4474
Signed-off-by: Edwin Kempin <ekempin@google.com>