src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/SearchIndexItem.java
author rriggs
Fri, 07 Dec 2018 11:51:17 -0500
changeset 52902 e3398b2e1ab0
parent 52695 99eb43bc3595
permissions -rw-r--r--
8214971: Replace use of string.equals("") with isEmpty() Reviewed-by: jlaskey, prappo, lancea, dfuchs, redestad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     1
/*
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
     2
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     4
 *
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    10
 *
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    15
 * accompanied this code).
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    16
 *
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    20
 *
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    23
 * questions.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    24
 */
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    25
35426
374342e56a56 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33920
diff changeset
    26
package jdk.javadoc.internal.doclets.formats.html;
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    27
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    28
/**
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    29
 * Index item for search.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    30
 *
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    31
 *  <p><b>This is NOT part of any supported API.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    32
 *  If you write code that depends on this, you do so at your own risk.
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    33
 *  This code and its internal interfaces are subject to change or
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    34
 *  deletion without notice.</b>
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    35
 */
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    36
public class SearchIndexItem {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    37
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    38
    enum Category {
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    39
        MODULES,
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    40
        PACKAGES,
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    41
        TYPES,
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    42
        MEMBERS,
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    43
        SEARCH_TAGS
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    44
    }
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    45
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    46
    private Category category;
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    47
    private String label = "";
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    48
    private String url = "";
40511
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
    49
    private String containingModule = "";
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    50
    private String containingPackage = "";
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    51
    private String containingClass = "";
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    52
    private String holder = "";
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    53
    private String description = "";
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    54
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    55
    public void setLabel(String l) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    56
        label = l;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    57
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    58
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    59
    public String getLabel() {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    60
        return label;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    61
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    62
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    63
    public void setUrl(String u) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    64
        url = u;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    65
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    66
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    67
    public String getUrl() {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    68
        return url;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    69
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    70
40511
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
    71
    public void setContainingModule(String m) {
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
    72
        containingModule = m;
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
    73
    }
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
    74
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    75
    public void setContainingPackage(String p) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    76
        containingPackage = p;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    77
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    78
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    79
    public void setContainingClass(String c) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    80
        containingClass = c;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    81
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    82
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
    83
    public void setCategory(Category c) {
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    84
        category = c;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    85
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    86
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    87
    public void setHolder(String h) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    88
        holder = h;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    89
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    90
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    91
    public String getHolder() {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    92
        return holder;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    93
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    94
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    95
    public void setDescription(String d) {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    96
        description = d;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    97
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    98
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
    99
    public String getDescription() {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   100
        return description;
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   101
    }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   102
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   103
    public String toString() {
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   104
        StringBuilder item = new StringBuilder("");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   105
        switch (category) {
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   106
        case MODULES:
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   107
            item.append("{")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   108
                    .append("\"l\":\"").append(label).append("\"")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   109
                    .append("}");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   110
            break;
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   111
        case PACKAGES:
40511
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
   112
            item.append("{");
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
   113
            if (!containingModule.isEmpty()) {
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
   114
                item.append("\"m\":\"").append(containingModule).append("\",");
1b3c502e0bdc 8155995: Update javadoc to include module search
bpatel
parents: 35426
diff changeset
   115
            }
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   116
            item.append("\"l\":\"").append(label).append("\"");
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52695
diff changeset
   117
            if (!url.isEmpty()) {
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   118
                item.append(",\"url\":\"").append(url).append("\"");
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   119
            }
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   120
            item.append("}");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   121
            break;
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   122
        case TYPES:
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   123
            item.append("{");
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52695
diff changeset
   124
            if (!containingPackage.isEmpty()) {
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   125
                item.append("\"p\":\"").append(containingPackage).append("\",");
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   126
            }
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   127
            item.append("\"l\":\"").append(label).append("\"");
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52695
diff changeset
   128
            if (!url.isEmpty()) {
50167
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   129
                item.append(",\"url\":\"").append(url).append("\"");
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   130
            }
cc705c956798 8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents: 47216
diff changeset
   131
            item.append("}");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   132
            break;
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   133
        case MEMBERS:
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   134
            item.append("{")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   135
                    .append("\"p\":\"").append(containingPackage).append("\",")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   136
                    .append("\"c\":\"").append(containingClass).append("\",")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   137
                    .append("\"l\":\"").append(label).append("\"");
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52695
diff changeset
   138
            if (!url.isEmpty()) {
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   139
                item.append(",\"url\":\"").append(url).append("\"");
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   140
            }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   141
            item.append("}");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   142
            break;
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   143
        case SEARCH_TAGS:
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   144
            item.append("{")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   145
                    .append("\"l\":\"").append(label).append("\",")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   146
                    .append("\"h\":\"").append(holder).append("\",");
52902
e3398b2e1ab0 8214971: Replace use of string.equals("") with isEmpty()
rriggs
parents: 52695
diff changeset
   147
            if (!description.isEmpty()) {
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   148
                item.append("\"d\":\"").append(description).append("\",");
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   149
            }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   150
            item.append("\"u\":\"").append(url).append("\"")
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   151
                    .append("}");
52695
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   152
            break;
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   153
        default:
99eb43bc3595 8213716: javadoc search not working with Japanese and Chinese locales
hannesw
parents: 50856
diff changeset
   154
            throw new IllegalStateException("category not set");
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   155
        }
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   156
        return item.toString();
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   157
    }
50856
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   158
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   159
    /**
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   160
     * Get the part of the label after the last dot, or whole label if no dots.
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   161
     *
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   162
     * @return the simple name
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   163
     */
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   164
    public String getSimpleName() {
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   165
        return label.substring(label.lastIndexOf('.') + 1);
1857ca5aca37 8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents: 50167
diff changeset
   166
    }
33920
bd731341c405 8141492: Implement search feature in javadoc
bpatel
parents:
diff changeset
   167
}