blob: f7a6e7be40c6b20eb39e498447853f66e6a8e4a1 (
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
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.devtools.build.docgen;
import static java.nio.charset.StandardCharsets.UTF_8;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
/**
* Class that represents a page to be generated using the {@link TemplateEngine}.
*/
class Page {
private final VelocityEngine engine;
private final VelocityContext context;
private final String template;
/**
* Creates a new Page instance using the reference to the VelocityEngine and the .vm
* template file path.
*/
public Page(VelocityEngine engine, String template) {
this.engine = engine;
this.template = template;
this.context = new VelocityContext();
}
/**
* Sets a Velocity variable in the template with the given value.
*/
public void add(String var, Object value) {
context.put(var, value);
}
/**
* Renders the template and writes the output to the given file.
*/
public void write(File outputFile) throws IOException {
OutputStream out = new FileOutputStream(outputFile);
try (Writer writer = new OutputStreamWriter(out, UTF_8)) {
engine.mergeTemplate(template, "UTF-8", context, writer);
} catch (ResourceNotFoundException|ParseErrorException|MethodInvocationException e) {
throw new IOException(e);
}
}
}
|
