blob: e904c53eb6953eb7c3e0e85c761f404c67b5f4da (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
/*
* Copyright (C) 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.doclava;
import com.google.doclava.apicheck.ApiCheck;
import com.google.doclava.apicheck.ApiInfo;
import com.google.doclava.apicheck.ApiParseException;
import java.net.MalformedURLException;
import java.net.URL;
/**
* A remote source of documentation that can be linked against. A federated
* site represents a library that has packages, classes, and members that may
* be referenced or shared across codebases.
*/
public final class FederatedSite {
private final String name;
private final URL baseUrl;
private final ApiInfo apiInfo;
public FederatedSite(String name, URL baseUrl) throws ApiParseException {
this.name = name;
this.baseUrl = baseUrl;
try {
URL xmlUrl = new URL(baseUrl + "/xml/current.xml");
this.apiInfo = new ApiCheck().parseApi(xmlUrl);
} catch (MalformedURLException e) {
throw new AssertionError(e);
}
}
/**
* Constructs a federated site using an api file not contained on
* the site itself.
*/
public FederatedSite(String name, URL baseUrl, String api) throws ApiParseException {
this.name = name;
this.baseUrl = baseUrl;
this.apiInfo = new ApiCheck().parseApi(api);
}
public String linkFor(String htmlPage) {
return baseUrl + "/" + htmlPage;
}
public String name() {
return name;
}
public ApiInfo apiInfo() {
return apiInfo;
}
public URL baseUrl() {
return baseUrl;
}
}
|
