search

o19s / opensearch-ubi

OpenSearch plugin for User Behavior Insights
Apache License 2.0
6 stars 1 forks source link

Add javadoc comments to get rid of build warnings #79

Closed RasonJ closed 8 months ago

RasonJ commented 8 months ago 
> Task :javadoc
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\AbstractEventManager.java:16: warning: no comment
public abstract class AbstractEventManager {
                ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\AbstractEventManager.java:20: warning: no comment
    protected final EventQueue eventQueue;
                               ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\AbstractEventManager.java:22: warning: no comment
    public AbstractEventManager() {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\AbstractEventManager.java:28: warning: no comment
    public abstract void add(Event event);
                         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\AbstractEventManager.java:26: warning: no comment
    public abstract void process();
                         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:16: warning: no comment
public interface Backend {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:20: warning: no comment
    void delete(final String storeName);
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:28: warning: no comment
    boolean exists(final String storeName);
            ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:26: warning: no comment
    Set<String> get();
                ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:18: warning: no comment
    void initialize(final String storeName);
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:22: warning: no comment
    void persistEvent(final String storeName, String eventJson);
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:24: warning: no comment
    void persistQuery(final String storeName, QueryRequest queryRequest, QueryResponse queryResponse) throws Exception;
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\Backend.java:30: warning: no comment
    boolean validateStoreName(final String storeName);
            ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\Event.java:11: warning: no comment
public class Event {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\Event.java:16: warning: no comment
    public Event(String indexName, String event) {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\Event.java:25: warning: no comment
    public String getEvent() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\Event.java:21: warning: no comment
    public String getIndexName() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\EventQueue.java:15: warning: no comment
public interface EventQueue {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\EventQueue.java:17: warning: no comment
    void add(Event event);
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\EventQueue.java:19: warning: no comment
    void clear();
         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\EventQueue.java:21: warning: no comment
    List<Event> get();
                ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\EventQueue.java:23: warning: no comment
    int size();
        ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:24: warning: no comment
    public String getHeader() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:11: warning: no comment
public enum HeaderConstants {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:14: warning: no comment
    EVENT_STORE_HEADER("X-ubi-store"),
    ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:13: warning: no comment
    QUERY_ID_HEADER("X-ubi-query-id"),
    ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:16: warning: no comment
    SESSION_ID_HEADER("X-ubi-session-id");
    ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\HeaderConstants.java:15: warning: no comment
    USER_ID_HEADER("X-ubi-user-id"),
    ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\InternalQueue.java:16: warning: no comment
public class InternalQueue implements EventQueue {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\queues\InternalQueue.java:16: warning: use of default constructor, which does not provide a comment
public class InternalQueue implements EventQueue {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\OpenSearchBackend.java:38: warning: no comment
public class OpenSearchBackend implements Backend {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\OpenSearchBackend.java:45: warning: no comment
    public static final int VERSION = 1;
                            ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\backends\OpenSearchBackend.java:49: warning: no comment
    public OpenSearchBackend(final Client client) {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\OpenSearchEventManager.java:18: warning: no comment
public class OpenSearchEventManager extends AbstractEventManager {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\events\OpenSearchEventManager.java:58: warning: no comment
    public static OpenSearchEventManager getInstance(Client client) {
                                         ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:11: warning: no comment
public class QueryRequest {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:19: warning: no comment
    public QueryRequest(final String queryId, final String query, final String userId, final String sessionId) {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:35: warning: no comment
    public String getQuery() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:31: warning: no comment
    public String getQueryId() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:43: warning: no comment
    public String getSessionId() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:27: warning: no comment
    public long getTimestamp() {
                ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryRequest.java:39: warning: no comment
    public String getUserId() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryResponse.java:13: warning: no comment
public class QueryResponse {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryResponse.java:19: warning: no comment
    public QueryResponse(final String queryId, final String queryResponseId, final List<String> queryResponseHitIds) {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryResponse.java:25: warning: no comment
    public String getQueryId() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryResponse.java:33: warning: no comment
    public List<String> getQueryResponseHitIds() {
                        ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\model\QueryResponse.java:29: warning: no comment
    public String getQueryResponseId() {
                  ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\SettingsConstants.java:11: warning: no comment
public class SettingsConstants {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\SettingsConstants.java:13: warning: no comment
    public static final String INDEX_NAMES = "plugins.ubi.indices";
                               ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\SettingsConstants.java:14: warning: no comment
    public static final String VERSION_SETTING = "index.ubistore.version";
                               ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\SettingsConstants.java:11: warning: use of default constructor, which does not provide a comment
public class SettingsConstants {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\action\UserBehaviorInsightsActionFilter.java:32: warning: no comment
public class UserBehaviorInsightsActionFilter implements ActionFilter {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\action\UserBehaviorInsightsActionFilter.java:40: warning: no comment
    public UserBehaviorInsightsActionFilter(final Backend backend, final Settings settings, ThreadPool threadPool) {
           ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\UserBehaviorInsightsPlugin.java:47: warning: no comment
public class UserBehaviorInsightsPlugin extends Plugin implements ActionPlugin {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\UserBehaviorInsightsPlugin.java:47: warning: use of default constructor, which does not provide a comment
public class UserBehaviorInsightsPlugin extends Plugin implements ActionPlugin {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\action\UserBehaviorInsightsRestHandler.java:31: warning: no comment
public class UserBehaviorInsightsRestHandler extends BaseRestHandler {
       ^
src\opensearch-ubi\src\main\java\org\opensearch\ubi\action\UserBehaviorInsightsRestHandler.java:37: warning: no comment
    public UserBehaviorInsightsRestHandler(final Backend backend) {