{"action":"created","comment":{"url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/comments/62839713","id":62839713,"diff_hunk":"@@ -233,6 +242,13 @@ public ExtendedSearchIntegrator getExtendedSearchIntegrator() {\n \t\treturn extendedIntegrator;\n \t}\n \n+\t/**\n+\t * Returns the names of the projection constants supported by a specific implementation in addition to projecting\n+\t * actual field values. If a given projection name begins with {@link #HSEARCH_PROJECTION_FIELD_PREFIX} and is not\n+\t * part of the set of constants returned by an implementation, an exception will be raised.\n+\t */\n+\tprotected abstract Set<String> getSupportedProjectionConstants();","path":"engine/src/main/java/org/hibernate/search/query/engine/impl/AbstractHSQuery.java","position":37,"original_position":37,"commit_id":"e0d21a61d05ff1c68d91794c3f09c9545ea97212","original_commit_id":"e0d21a61d05ff1c68d91794c3f09c9545ea97212","user":{"login":"gunnarmorling","id":28612,"avatar_url":"https://avatars.githubusercontent.com/u/28612?v=3","gravatar_id":"","url":"https://api.github.com/users/gunnarmorling","html_url":"https://github.com/gunnarmorling","followers_url":"https://api.github.com/users/gunnarmorling/followers","following_url":"https://api.github.com/users/gunnarmorling/following{/other_user}","gists_url":"https://api.github.com/users/gunnarmorling/gists{/gist_id}","starred_url":"https://api.github.com/users/gunnarmorling/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gunnarmorling/subscriptions","organizations_url":"https://api.github.com/users/gunnarmorling/orgs","repos_url":"https://api.github.com/users/gunnarmorling/repos","events_url":"https://api.github.com/users/gunnarmorling/events{/privacy}","received_events_url":"https://api.github.com/users/gunnarmorling/received_events","type":"User","site_admin":false},"body":"I'm using that style - providing contents for the \"main\" section, but omitting `@return` if it doesn't add any value - on purpose actually. It reads better that way in rendered JavaDoc than the other way around.\r\n\r\nTo avoid redundancy, I rarely use both. If I do it, then I have a general description in the main part (as the case here), and a description of specific values in the `@return` part (e.g. \"@return null if bla bla bla, foo bar baz otherwise.\").\r\n\r\nIt's not something we ever formally agreed on, just the way I came to think is providing most benefit.","created_at":"2016-05-11T12:37:47Z","updated_at":"2016-05-11T12:37:47Z","html_url":"https://github.com/hibernate/hibernate-search/pull/1101#discussion_r62839713","pull_request_url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101","_links":{"self":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/comments/62839713"},"html":{"href":"https://github.com/hibernate/hibernate-search/pull/1101#discussion_r62839713"},"pull_request":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101"}}},"pull_request":{"url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101","id":68677895,"html_url":"https://github.com/hibernate/hibernate-search/pull/1101","diff_url":"https://github.com/hibernate/hibernate-search/pull/1101.diff","patch_url":"https://github.com/hibernate/hibernate-search/pull/1101.patch","issue_url":"https://api.github.com/repos/hibernate/hibernate-search/issues/1101","number":1101,"state":"open","locked":false,"title":"HSEARCH-2106 Using unique name for ES projection constants interface;…","user":{"login":"gunnarmorling","id":28612,"avatar_url":"https://avatars.githubusercontent.com/u/28612?v=3","gravatar_id":"","url":"https://api.github.com/users/gunnarmorling","html_url":"https://github.com/gunnarmorling","followers_url":"https://api.github.com/users/gunnarmorling/followers","following_url":"https://api.github.com/users/gunnarmorling/following{/other_user}","gists_url":"https://api.github.com/users/gunnarmorling/gists{/gist_id}","starred_url":"https://api.github.com/users/gunnarmorling/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gunnarmorling/subscriptions","organizations_url":"https://api.github.com/users/gunnarmorling/orgs","repos_url":"https://api.github.com/users/gunnarmorling/repos","events_url":"https://api.github.com/users/gunnarmorling/events{/privacy}","received_events_url":"https://api.github.com/users/gunnarmorling/received_events","type":"User","site_admin":false},"body":"… Only exposing constants actually supported\r\n\r\nI made the ES constants interface not extend `ProjectionConstants` anymore and gave it a unique name. With that most wrong usages are avoided as auto-completion won't give you wrong candidates. I don't think it needs a strongly type-safe approach.","created_at":"2016-05-03T09:18:05Z","updated_at":"2016-05-11T12:37:47Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0007305b4319ed8126c4ecd17db07c12c9df6192","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101/commits","review_comments_url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101/comments","review_comment_url":"https://api.github.com/repos/hibernate/hibernate-search/pulls/comments{/number}","comments_url":"https://api.github.com/repos/hibernate/hibernate-search/issues/1101/comments","statuses_url":"https://api.github.com/repos/hibernate/hibernate-search/statuses/e0d21a61d05ff1c68d91794c3f09c9545ea97212","head":{"label":"gunnarmorling:HSEARCH-2106","ref":"HSEARCH-2106","sha":"e0d21a61d05ff1c68d91794c3f09c9545ea97212","user":{"login":"gunnarmorling","id":28612,"avatar_url":"https://avatars.githubusercontent.com/u/28612?v=3","gravatar_id":"","url":"https://api.github.com/users/gunnarmorling","html_url":"https://github.com/gunnarmorling","followers_url":"https://api.github.com/users/gunnarmorling/followers","following_url":"https://api.github.com/users/gunnarmorling/following{/other_user}","gists_url":"https://api.github.com/users/gunnarmorling/gists{/gist_id}","starred_url":"https://api.github.com/users/gunnarmorling/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gunnarmorling/subscriptions","organizations_url":"https://api.github.com/users/gunnarmorling/orgs","repos_url":"https://api.github.com/users/gunnarmorling/repos","events_url":"https://api.github.com/users/gunnarmorling/events{/privacy}","received_events_url":"https://api.github.com/users/gunnarmorling/received_events","type":"User","site_admin":false},"repo":{"id":10077974,"name":"hibernate-search","full_name":"gunnarmorling/hibernate-search","owner":{"login":"gunnarmorling","id":28612,"avatar_url":"https://avatars.githubusercontent.com/u/28612?v=3","gravatar_id":"","url":"https://api.github.com/users/gunnarmorling","html_url":"https://github.com/gunnarmorling","followers_url":"https://api.github.com/users/gunnarmorling/followers","following_url":"https://api.github.com/users/gunnarmorling/following{/other_user}","gists_url":"https://api.github.com/users/gunnarmorling/gists{/gist_id}","starred_url":"https://api.github.com/users/gunnarmorling/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gunnarmorling/subscriptions","organizations_url":"https://api.github.com/users/gunnarmorling/orgs","repos_url":"https://api.github.com/users/gunnarmorling/repos","events_url":"https://api.github.com/users/gunnarmorling/events{/privacy}","received_events_url":"https://api.github.com/users/gunnarmorling/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/gunnarmorling/hibernate-search","description":"Hibernate Search: full-text search for domain model","fork":true,"url":"https://api.github.com/repos/gunnarmorling/hibernate-search","forks_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/forks","keys_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/teams","hooks_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/hooks","issue_events_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/issues/events{/number}","events_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/events","assignees_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/assignees{/user}","branches_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/branches{/branch}","tags_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/tags","blobs_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/git/refs{/sha}","trees_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/statuses/{sha}","languages_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/languages","stargazers_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/stargazers","contributors_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/contributors","subscribers_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/subscribers","subscription_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/subscription","commits_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/commits{/sha}","git_commits_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/git/commits{/sha}","comments_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/comments{/number}","issue_comment_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/issues/comments{/number}","contents_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/contents/{+path}","compare_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/merges","archive_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/downloads","issues_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/issues{/number}","pulls_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/pulls{/number}","milestones_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/milestones{/number}","notifications_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/labels{/name}","releases_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/releases{/id}","deployments_url":"https://api.github.com/repos/gunnarmorling/hibernate-search/deployments","created_at":"2013-05-15T12:21:58Z","updated_at":"2014-08-07T13:43:45Z","pushed_at":"2016-05-11T09:48:52Z","git_url":"git://github.com/gunnarmorling/hibernate-search.git","ssh_url":"git@github.com:gunnarmorling/hibernate-search.git","clone_url":"https://github.com/gunnarmorling/hibernate-search.git","svn_url":"https://github.com/gunnarmorling/hibernate-search","homepage":"http://search.hibernate.org","size":44751,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":false,"has_downloads":false,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"hibernate:master","ref":"master","sha":"ae8300b588d0816cbb9cf53c0d495e0e10dd3235","user":{"login":"hibernate","id":348262,"avatar_url":"https://avatars.githubusercontent.com/u/348262?v=3","gravatar_id":"","url":"https://api.github.com/users/hibernate","html_url":"https://github.com/hibernate","followers_url":"https://api.github.com/users/hibernate/followers","following_url":"https://api.github.com/users/hibernate/following{/other_user}","gists_url":"https://api.github.com/users/hibernate/gists{/gist_id}","starred_url":"https://api.github.com/users/hibernate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hibernate/subscriptions","organizations_url":"https://api.github.com/users/hibernate/orgs","repos_url":"https://api.github.com/users/hibernate/repos","events_url":"https://api.github.com/users/hibernate/events{/privacy}","received_events_url":"https://api.github.com/users/hibernate/received_events","type":"Organization","site_admin":false},"repo":{"id":990281,"name":"hibernate-search","full_name":"hibernate/hibernate-search","owner":{"login":"hibernate","id":348262,"avatar_url":"https://avatars.githubusercontent.com/u/348262?v=3","gravatar_id":"","url":"https://api.github.com/users/hibernate","html_url":"https://github.com/hibernate","followers_url":"https://api.github.com/users/hibernate/followers","following_url":"https://api.github.com/users/hibernate/following{/other_user}","gists_url":"https://api.github.com/users/hibernate/gists{/gist_id}","starred_url":"https://api.github.com/users/hibernate/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hibernate/subscriptions","organizations_url":"https://api.github.com/users/hibernate/orgs","repos_url":"https://api.github.com/users/hibernate/repos","events_url":"https://api.github.com/users/hibernate/events{/privacy}","received_events_url":"https://api.github.com/users/hibernate/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/hibernate/hibernate-search","description":"Hibernate Search: full-text search for domain model","fork":false,"url":"https://api.github.com/repos/hibernate/hibernate-search","forks_url":"https://api.github.com/repos/hibernate/hibernate-search/forks","keys_url":"https://api.github.com/repos/hibernate/hibernate-search/keys{/key_id}","collaborators_url":"https://api.github.com/repos/hibernate/hibernate-search/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/hibernate/hibernate-search/teams","hooks_url":"https://api.github.com/repos/hibernate/hibernate-search/hooks","issue_events_url":"https://api.github.com/repos/hibernate/hibernate-search/issues/events{/number}","events_url":"https://api.github.com/repos/hibernate/hibernate-search/events","assignees_url":"https://api.github.com/repos/hibernate/hibernate-search/assignees{/user}","branches_url":"https://api.github.com/repos/hibernate/hibernate-search/branches{/branch}","tags_url":"https://api.github.com/repos/hibernate/hibernate-search/tags","blobs_url":"https://api.github.com/repos/hibernate/hibernate-search/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/hibernate/hibernate-search/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/hibernate/hibernate-search/git/refs{/sha}","trees_url":"https://api.github.com/repos/hibernate/hibernate-search/git/trees{/sha}","statuses_url":"https://api.github.com/repos/hibernate/hibernate-search/statuses/{sha}","languages_url":"https://api.github.com/repos/hibernate/hibernate-search/languages","stargazers_url":"https://api.github.com/repos/hibernate/hibernate-search/stargazers","contributors_url":"https://api.github.com/repos/hibernate/hibernate-search/contributors","subscribers_url":"https://api.github.com/repos/hibernate/hibernate-search/subscribers","subscription_url":"https://api.github.com/repos/hibernate/hibernate-search/subscription","commits_url":"https://api.github.com/repos/hibernate/hibernate-search/commits{/sha}","git_commits_url":"https://api.github.com/repos/hibernate/hibernate-search/git/commits{/sha}","comments_url":"https://api.github.com/repos/hibernate/hibernate-search/comments{/number}","issue_comment_url":"https://api.github.com/repos/hibernate/hibernate-search/issues/comments{/number}","contents_url":"https://api.github.com/repos/hibernate/hibernate-search/contents/{+path}","compare_url":"https://api.github.com/repos/hibernate/hibernate-search/compare/{base}...{head}","merges_url":"https://api.github.com/repos/hibernate/hibernate-search/merges","archive_url":"https://api.github.com/repos/hibernate/hibernate-search/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/hibernate/hibernate-search/downloads","issues_url":"https://api.github.com/repos/hibernate/hibernate-search/issues{/number}","pulls_url":"https://api.github.com/repos/hibernate/hibernate-search/pulls{/number}","milestones_url":"https://api.github.com/repos/hibernate/hibernate-search/milestones{/number}","notifications_url":"https://api.github.com/repos/hibernate/hibernate-search/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/hibernate/hibernate-search/labels{/name}","releases_url":"https://api.github.com/repos/hibernate/hibernate-search/releases{/id}","deployments_url":"https://api.github.com/repos/hibernate/hibernate-search/deployments","created_at":"2010-10-15T15:55:09Z","updated_at":"2016-05-06T19:45:13Z","pushed_at":"2016-05-11T12:21:54Z","git_url":"git://github.com/hibernate/hibernate-search.git","ssh_url":"git@github.com:hibernate/hibernate-search.git","clone_url":"https://github.com/hibernate/hibernate-search.git","svn_url":"https://github.com/hibernate/hibernate-search","homepage":"http://search.hibernate.org","size":54394,"stargazers_count":184,"watchers_count":184,"language":"Java","has_issues":false,"has_downloads":false,"has_wiki":false,"has_pages":false,"forks_count":127,"mirror_url":null,"open_issues_count":11,"forks":127,"open_issues":11,"watchers":184,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101"},"html":{"href":"https://github.com/hibernate/hibernate-search/pull/1101"},"issue":{"href":"https://api.github.com/repos/hibernate/hibernate-search/issues/1101"},"comments":{"href":"https://api.github.com/repos/hibernate/hibernate-search/issues/1101/comments"},"review_comments":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101/comments"},"review_comment":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/hibernate/hibernate-search/pulls/1101/commits"},"statuses":{"href":"https://api.github.com/repos/hibernate/hibernate-search/statuses/e0d21a61d05ff1c68d91794c3f09c9545ea97212"}}}}