com.phloc.commons.microdom.serialize.MicroDOMInputStreamProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-commons Show documentation
phloc very basic stuff
There is a newer version: 5.0.0
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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.phloc.commons.microdom.serialize;

import java.nio.charset.Charset;

import javax.annotation.Nonnull;

import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.io.streamprovider.StringInputStreamProvider;
import com.phloc.commons.microdom.IMicroNode;
import com.phloc.commons.xml.serialize.IXMLWriterSettings;
import com.phloc.commons.xml.serialize.XMLWriterSettings;

/**
 * A special input stream provider that takes an existing {@link IMicroNode} and
 * converts it to a byte array.
 * 
 * @author Philip Helger
 */
public class MicroDOMInputStreamProvider extends StringInputStreamProvider
{
  /**
   * Constructor for MicroNodes using the default charset.
   * 
   * @param aNode
   *        The node to be streamed. May not be null.
   * @see XMLWriterSettings#DEFAULT_XML_CHARSET
   */
  public MicroDOMInputStreamProvider (@Nonnull final IMicroNode aNode)
  {
    this (aNode, XMLWriterSettings.DEFAULT_XML_SETTINGS);
  }

  /**
   * Constructor for MicroNodes.
   * 
   * @param aNode
   *        The node to be streamed. May not be null.
   * @param sCharset
   *        The charset to use. May not be null.
   */
  @Deprecated
  public MicroDOMInputStreamProvider (@Nonnull final IMicroNode aNode, @Nonnull @Nonempty final String sCharset)
  {
    this (aNode, new XMLWriterSettings ().setCharset (sCharset));
  }

  /**
   * Constructor for MicroNodes.
   * 
   * @param aNode
   *        The node to be streamed. May not be null.
   * @param aCharset
   *        The charset to use. May not be null.
   */
  public MicroDOMInputStreamProvider (@Nonnull final IMicroNode aNode, @Nonnull final Charset aCharset)
  {
    this (aNode, new XMLWriterSettings ().setCharset (aCharset));
  }

  /**
   * Constructor for micro nodes.
   * 
   * @param aNode
   *        The node to be streamed. May not be null.
   * @param aSettings
   *        The settings to use. May not be null.
   */
  public MicroDOMInputStreamProvider (@Nonnull final IMicroNode aNode, @Nonnull final IXMLWriterSettings aSettings)
  {
    super (MicroWriter.getNodeAsString (aNode, aSettings), aSettings.getCharsetObj ());
  }
}