1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2015 ForgeRock AS.
15 */
16
17 package org.forgerock.doc.maven.utils;
18
19 import org.forgerock.doc.maven.utils.helper.FileFilterFactory;
20
21 /**
22 * Update XML files based on an XSL resource.
23 */
24 public class KeepTogetherTransformer extends XmlTransformer {
25
26 /**
27 * Construct an updater to match DocBook XML files.
28 *
29 * <p>
30 *
31 * The files are updated in place.
32 *
33 * <p>
34 *
35 * The following example shows how this might be used in your code.
36 *
37 * <pre>
38 * File xmlSourceDirectory = new File("/path/to/xml/files/");
39 *
40 * // Update XML files.
41 * KeepTogetherTransformer xslt = new KeepTogetherTransformer();
42 * return xslt.update(xmlSourceDirectory);
43 * </pre>
44 */
45 public KeepTogetherTransformer() {
46 super(FileFilterFactory.getXmlFileFilter(), "/xslt/keep-together.xsl");
47 }
48 }