author | jjg |
Mon, 22 Jan 2018 11:15:51 -0800 | |
changeset 48654 | 36f58bd6269f |
parent 48029 | e9dab2492924 |
child 48759 | ffa68af7da87 |
permissions | -rw-r--r-- |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
1 |
/* |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
2 |
* Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
4 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
10 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
15 |
* accompanied this code). |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
16 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
20 |
* |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
23 |
* questions. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
24 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
25 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit.util; |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
27 |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
28 |
import java.util.ArrayList; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
29 |
import java.util.Arrays; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
30 |
import java.util.Collections; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
31 |
import java.util.List; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
32 |
|
48029
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
33 |
import javax.lang.model.element.ModuleElement; |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
34 |
import javax.lang.model.element.PackageElement; |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
35 |
import javax.lang.model.element.TypeElement; |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
36 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
37 |
/** |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
38 |
* Abstraction for immutable relative paths. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
39 |
* Paths always use '/' as a separator, and never begin or end with '/'. |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
40 |
* |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
41 |
* <p><b>This is NOT part of any supported API. |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
42 |
* If you write code that depends on this, you do so at your own risk. |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
43 |
* This code and its internal interfaces are subject to change or |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
44 |
* deletion without notice.</b> |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
45 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
46 |
public class DocPath { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
47 |
private final String path; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
48 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
49 |
/** The empty path. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
50 |
public static final DocPath empty = new DocPath(""); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
51 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
52 |
/** The empty path. */ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
53 |
public static final DocPath parent = new DocPath(".."); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
54 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
55 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
56 |
* Creates a path from a string. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
57 |
* @param p the string |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
58 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
59 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
60 |
public static DocPath create(String p) { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
61 |
return (p == null) || p.isEmpty() ? empty : new DocPath(p); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
62 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
63 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
64 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
65 |
* Returns the path for a class. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
66 |
* For example, if the class is java.lang.Object, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
67 |
* the path is java/lang/Object.html. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
68 |
* @param utils utility class for handling type elements |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
69 |
* @param typeElement the type element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
70 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
71 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
72 |
public static DocPath forClass(Utils utils, TypeElement typeElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
73 |
return (typeElement == null) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
74 |
? empty |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
75 |
: forPackage(utils.containingPackage(typeElement)).resolve(forName(utils, typeElement)); |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
76 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
77 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
78 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
79 |
* Returns the path for the simple name of a class. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
80 |
* For example, if the class is java.lang.Object, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
81 |
* the path is Object.html. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
82 |
* @param utils utility class for handling type elements |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
83 |
* @param typeElement the type element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
84 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
85 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
86 |
public static DocPath forName(Utils utils, TypeElement typeElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
87 |
return (typeElement == null) ? empty : new DocPath(utils.getSimpleName(typeElement) + ".html"); |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
88 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
89 |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
90 |
/** |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
91 |
* Returns the path for the name of a module. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
92 |
* For example, if the module is java.base, |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
93 |
* the path is java.base. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
94 |
* @param mdle the module element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
95 |
* @return the path |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
96 |
*/ |
48029
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
97 |
public static DocPath forModule(ModuleElement mdle) { |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
98 |
return mdle == null || mdle.isUnnamed() |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
99 |
? empty |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
100 |
: DocPath.create(mdle.getQualifiedName().toString()); |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
101 |
} |
e9dab2492924
8185985: Html files in doc-files directories should be wrapped with standard header and footer
ksrini
parents:
47216
diff
changeset
|
102 |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
103 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
104 |
* Returns the path for the package of a class. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
105 |
* For example, if the class is java.lang.Object, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
106 |
* the path is java/lang. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
107 |
* @param utils utility class for handling type elements |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
108 |
* @param typeElement the type element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
109 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
110 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
111 |
public static DocPath forPackage(Utils utils, TypeElement typeElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
112 |
return (typeElement == null) ? empty : forPackage(utils.containingPackage(typeElement)); |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
113 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
114 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
115 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
116 |
* Returns the path for a package. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
117 |
* For example, if the package is java.lang, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
118 |
* the path is java/lang. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
119 |
* @param pkgElement the package element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
120 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
121 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
122 |
public static DocPath forPackage(PackageElement pkgElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
123 |
return pkgElement == null || pkgElement.isUnnamed() |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
124 |
? empty |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
125 |
: DocPath.create(pkgElement.getQualifiedName().toString().replace('.', '/')); |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
126 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
127 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
128 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
129 |
* Returns the inverse path for a package. |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
130 |
* For example, if the package is java.lang, |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
131 |
* the inverse path is ../... |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
132 |
* @param pkgElement the package element |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
133 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
134 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
135 |
public static DocPath forRoot(PackageElement pkgElement) { |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
136 |
String name = (pkgElement == null || pkgElement.isUnnamed()) |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
137 |
? "" |
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
138 |
: pkgElement.getQualifiedName().toString(); |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
139 |
return new DocPath(name.replace('.', '/').replaceAll("[^/]+", "..")); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
140 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
141 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
142 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
143 |
* Returns the relative path from one package to another. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
144 |
* @param from the initial package |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
145 |
* @param to the target package |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
146 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
147 |
*/ |
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
148 |
public static DocPath relativePath(PackageElement from, PackageElement to) { |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
149 |
return forRoot(from).resolve(forPackage(to)); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
150 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
151 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
152 |
protected DocPath(String p) { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
153 |
path = (p.endsWith("/") ? p.substring(0, p.length() - 1) : p); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
154 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
155 |
|
14366
af625e568667
8001929: fix doclint errors in langtools doc comments
jjg
parents:
14358
diff
changeset
|
156 |
/** {@inheritDoc} */ |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
157 |
@Override |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
158 |
public boolean equals(Object other) { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
159 |
return (other instanceof DocPath) && path.equals(((DocPath)other).path); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
160 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
161 |
|
14366
af625e568667
8001929: fix doclint errors in langtools doc comments
jjg
parents:
14358
diff
changeset
|
162 |
/** {@inheritDoc} */ |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
163 |
@Override |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
164 |
public int hashCode() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
165 |
return path.hashCode(); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
166 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
167 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
168 |
public DocPath basename() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
169 |
int sep = path.lastIndexOf("/"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
170 |
return (sep == -1) ? this : new DocPath(path.substring(sep + 1)); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
171 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
172 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
173 |
public DocPath parent() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
174 |
int sep = path.lastIndexOf("/"); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
175 |
return (sep == -1) ? empty : new DocPath(path.substring(0, sep)); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
176 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
177 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
178 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
179 |
* Returns the path formed by appending the specified string to the current path. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
180 |
* @param p the string |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
181 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
182 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
183 |
public DocPath resolve(String p) { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
184 |
if (p == null || p.isEmpty()) |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
185 |
return this; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
186 |
if (path.isEmpty()) |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
187 |
return new DocPath(p); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
188 |
return new DocPath(path + "/" + p); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
189 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
190 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
191 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
192 |
* Returns the path by appending the specified path to the current path. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
193 |
* @param p the path |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
194 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
195 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
196 |
public DocPath resolve(DocPath p) { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
197 |
if (p == null || p.isEmpty()) |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
198 |
return this; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
199 |
if (path.isEmpty()) |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
200 |
return p; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
201 |
return new DocPath(path + "/" + p.getPath()); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
202 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
203 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
204 |
/** |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
205 |
* Return the inverse path for this path. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
206 |
* For example, if the path is a/b/c, the inverse path is ../../.. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
207 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
208 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
209 |
public DocPath invert() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
210 |
return new DocPath(path.replaceAll("[^/]+", "..")); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
211 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
212 |
|
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
213 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
214 |
* Returns the path formed by eliminating empty components, |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
215 |
* '.' components, and redundant name/.. components. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
216 |
* @return the path |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
217 |
*/ |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
218 |
public DocPath normalize() { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
219 |
return path.isEmpty() |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
220 |
? this |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
221 |
: new DocPath(String.join("/", normalize(path))); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
222 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
223 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
224 |
private static List<String> normalize(String path) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
225 |
return normalize(Arrays.asList(path.split("/"))); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
226 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
227 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
228 |
private static List<String> normalize(List<String> parts) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
229 |
if (parts.stream().noneMatch(s -> s.isEmpty() || s.equals(".") || s.equals(".."))) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
230 |
return parts; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
231 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
232 |
List<String> normalized = new ArrayList<>(); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
233 |
for (String part : parts) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
234 |
switch (part) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
235 |
case "": |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
236 |
case ".": |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
237 |
break; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
238 |
case "..": |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
239 |
int n = normalized.size(); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
240 |
if (n > 0 && !normalized.get(n - 1).equals("..")) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
241 |
normalized.remove(n - 1); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
242 |
} else { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
243 |
normalized.add(part); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
244 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
245 |
break; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
246 |
default: |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
247 |
normalized.add(part); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
248 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
249 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
250 |
return normalized; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
251 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
252 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
253 |
/** |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
254 |
* Normalize and relativize a path against this path, |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
255 |
* assuming that this path is for a file (not a directory), |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
256 |
* in which the other path will appear. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
257 |
* |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
258 |
* @param other the path to be relativized. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
259 |
* @return the simplified path |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
260 |
*/ |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
261 |
public DocPath relativize(DocPath other) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
262 |
if (other == null || other.path.isEmpty()) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
263 |
return this; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
264 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
265 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
266 |
if (path.isEmpty()) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
267 |
return other; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
268 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
269 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
270 |
List<String> originParts = normalize(path); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
271 |
int sep = path.lastIndexOf("/"); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
272 |
List<String> destParts = sep == -1 |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
273 |
? normalize(other.path) |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
274 |
: normalize(path.substring(0, sep + 1) + other.path); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
275 |
int common = 0; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
276 |
while (common < originParts.size() |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
277 |
&& common < destParts.size() |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
278 |
&& originParts.get(common).equals(destParts.get(common))) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
279 |
common++; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
280 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
281 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
282 |
List<String> newParts; |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
283 |
if (common == originParts.size()) { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
284 |
newParts = destParts.subList(common, destParts.size()); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
285 |
} else { |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
286 |
newParts = new ArrayList<>(); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
287 |
newParts.addAll(Collections.nCopies(originParts.size() - common - 1, "..")); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
288 |
newParts.addAll(destParts.subList(common, destParts.size())); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
289 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
290 |
return new DocPath(String.join("/", newParts)); |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
291 |
} |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
292 |
|
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
293 |
/** |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
294 |
* Return true if this path is empty. |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
295 |
* @return true if this path is empty |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
296 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
297 |
public boolean isEmpty() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
298 |
return path.isEmpty(); |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
299 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
300 |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
301 |
/** |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
302 |
* Creates a DocLink formed from this path and a fragment identifier. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
303 |
* @param fragment the fragment |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
304 |
* @return the link |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
305 |
*/ |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
306 |
public DocLink fragment(String fragment) { |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
307 |
return new DocLink(path, null, fragment); |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
308 |
} |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
309 |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
310 |
/** |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
311 |
* Creates a DocLink formed from this path and a query string. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
312 |
* @param query the query string |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
313 |
* @return the link |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
314 |
*/ |
14358
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
315 |
public DocLink query(String query) { |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
316 |
return new DocLink(path, query, null); |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
317 |
} |
9eda9239cba0
8000416: refactor javadoc to provide and use an abstraction for relative URIs
jjg
parents:
14357
diff
changeset
|
318 |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
319 |
/** |
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
320 |
* Returns this path as a string. |
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
48029
diff
changeset
|
321 |
* @return the path |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
322 |
*/ |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
323 |
// This is provided instead of using toString() to help catch |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
324 |
// unintended use of toString() in string concatenation sequences. |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
325 |
public String getPath() { |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
326 |
return path; |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
327 |
} |
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
diff
changeset
|
328 |
} |