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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*******************************************************************************
* Copyright (c) 2009, 2021 Mountainminds GmbH & Co. KG and Contributors
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Marc R. Hoffmann - initial API and implementation
*
*******************************************************************************/
package org.jacoco.report.internal;
import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;
import org.jacoco.report.IMultiReportOutput;
/**
* Logical representation of a folder in the output structure. This utility
* ensures valid and unique file names and helps to create relative links.
*/
public class ReportOutputFolder {
private final IMultiReportOutput output;
private final ReportOutputFolder parent;
private final String path;
/** Cached sub-folder instances to guarantee stable normalization */
private final Map<String, ReportOutputFolder> subFolders = new HashMap<String, ReportOutputFolder>();
private final NormalizedFileNames fileNames;
/**
* Creates a new root folder for the given output.
*
* @param output
* output for generated files
*/
public ReportOutputFolder(final IMultiReportOutput output) {
this(output, null, "");
}
/**
* Creates a new root folder for the given output.
*
* @param output
* output for generated files
*/
private ReportOutputFolder(final IMultiReportOutput output,
final ReportOutputFolder parent, final String path) {
this.output = output;
this.parent = parent;
this.path = path;
fileNames = new NormalizedFileNames();
}
/**
* Creates a sub-folder with the given name.
*
* @param name
* name of the sub-folder
* @return handle for output into the sub-folder
*/
public ReportOutputFolder subFolder(final String name) {
final String normalizedName = normalize(name);
ReportOutputFolder folder = subFolders.get(normalizedName);
if (folder != null) {
return folder;
}
folder = new ReportOutputFolder(output, this,
path + normalizedName + "/");
subFolders.put(normalizedName, folder);
return folder;
}
/**
* Creates a new file in this folder with the given local name.
*
* @param name
* name of the sub-folder
* @return handle for output into the sub-folder
* @throws IOException
* if the file creation fails
*/
public OutputStream createFile(final String name) throws IOException {
return output.createFile(path + normalize(name));
}
/**
* Returns a link relative to a given base to a resource within this folder.
*
* @param base
* base to create the relative link from
* @param name
* name of the file or folder in this folder
* @return relative link
* @throws IllegalArgumentException
* if this folder and the base do not have the same root
*/
public String getLink(final ReportOutputFolder base, final String name) {
if (base.isAncestorOf(this)) {
return this.path.substring(base.path.length()) + normalize(name);
}
if (base.parent == null) {
throw new IllegalArgumentException("Folders with different roots.");
}
return "../" + this.getLink(base.parent, name);
}
private boolean isAncestorOf(final ReportOutputFolder folder) {
if (this == folder) {
return true;
}
return folder.parent == null ? false : isAncestorOf(folder.parent);
}
private String normalize(final String name) {
return fileNames.getFileName(name);
}
}
|
