org.xmlunit.input.WhitespaceStrippedSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xmlunit-core Show documentation

XMLUnit for Java

There is a newer version: 2.10.0

/*
  This file is licensed to You 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 org.xmlunit.input;

import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import org.xmlunit.util.Convert;
import org.xmlunit.util.Nodes;

/**
 * A source that is obtained from a different source by removing all
 * empty text nodes and trimming the non-empty ones.
 *
 * If you only want to remove text nodes consisting solely of
 * whitespace (AKA element content whitespace) but leave all other
 * text nodes alone you should use {@link
 * ElementContentWhitespaceStrippedSource} instead.
 */
public class WhitespaceStrippedSource extends DOMSource {

    /**
     * Creates a new source that consists of the given source with all
     * empty text nodes removed and all non-empty text nodes trimmed.
     *
     * @param originalSource the original source
     */
    public WhitespaceStrippedSource(Source originalSource) {
        super(Nodes.stripWhitespace(Convert.toDocument(originalSource)));
        setSystemId(originalSource.getSystemId());
    }

    /**
     * Creates a new source that consists of the given source with all
     * empty text nodes removed and all non-empty text nodes trimmed.
     *
     * @param originalSource the original source
     * @param dbf the DocumentBuilderFactory to use when creating a
     * DOM document from originalSource
     */
    public WhitespaceStrippedSource(Source originalSource,
                                    DocumentBuilderFactory dbf) {
        super(Nodes.stripWhitespace(Convert.toDocument(originalSource, dbf)));
        setSystemId(originalSource.getSystemId());
    }
}