001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016
017package org.forgerock.doc.maven.utils;
018
019import org.forgerock.doc.maven.utils.helper.FileFilterFactory;
020
021/**
022 * Update XML files based on an XSL resource.
023 */
024public class KeepTogetherTransformer extends XmlTransformer {
025
026    /**
027     * Construct an updater to match DocBook XML files.
028     *
029     * <p>
030     *
031     * The files are updated in place.
032     *
033     * <p>
034     *
035     * The following example shows how this might be used in your code.
036     *
037     * <pre>
038     *     File xmlSourceDirectory  = new File("/path/to/xml/files/");
039     *
040     *     // Update XML files.
041     *     KeepTogetherTransformer xslt = new KeepTogetherTransformer();
042     *     return xslt.update(xmlSourceDirectory);
043     * </pre>
044     */
045    public KeepTogetherTransformer() {
046        super(FileFilterFactory.getXmlFileFilter(), "/xslt/keep-together.xsl");
047    }
048}