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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
*
* 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 io.fd.hc2vpp.docs.core;
import static java.lang.String.format;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Index of java classes to relative absolute paths within repository. Used to generate Git links for binding classes of
* VPP apis
*/
public class ClassPathTypeIndex implements LinkGenerator {
private static final Logger LOG = LoggerFactory.getLogger(ClassPathTypeIndex.class);
private static final String JAVA_SOURCE_FOLDER = "src/main/java";
private static final int JAVA_SOURCE_FOLDER_NAME_LENGTH = JAVA_SOURCE_FOLDER.length() + 1;
/**
* <li>key - fully qualified class name value</li><li>value - path within codebase/repository</li>
*/
private final Map<String, String> index;
public ClassPathTypeIndex(final String projectRoot) {
index = buildIndex(projectRoot);
}
/**
* <li>input format - LOCAL_ROOT/hc2vpp/module/src/main/java/fully/qualified/class/name/Class.java</li><li>output
* format - fully.qualified.class.name.Class</li>
*/
private static String key(String raw) {
return raw.substring(raw.indexOf(JAVA_SOURCE_FOLDER) + JAVA_SOURCE_FOLDER_NAME_LENGTH)
.replace("/", ".")
.replace(".java", "");
}
public String linkForClass(final String clazz) {
return index.get(clazz.replace("/", "."));
}
private Map<String, String> buildIndex(final String projectRoot) {
try {
Set<String> names =
Files.walk(Paths.get(projectRoot))
.filter(path -> path.toString().contains("src/main/java"))
.filter(path -> path.toString().endsWith(".java"))
.map(Path::toString)
.map(s -> s.replace(projectRoot, ""))
.collect(Collectors.toSet());
Map<String, String> register = new HashMap<>();
for (String name : names) {
String key = key(name);
if (register.containsKey(key)) {
/* expected duplicates e.g. In MPLS and SRV6 modules several same types are used
(like ipv6-multicast-source-address). We don`t need to create another link for the same class
so we can skip these duplicates */
LOG.trace("Duplicate key found for name: {}. Skip generating new link for the same class", name);
} else {
register.put(key, generateLink(name));
}
}
return register;
} catch (IOException e) {
throw new IllegalStateException(format("%s not found", projectRoot), e);
}
}
}
|
