com.phloc.commons.xml.serialize.IXMLSerializer Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 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.xml.serialize;
import java.io.OutputStream;
import java.io.Writer;
import javax.annotation.Nonnull;
import javax.annotation.WillNotClose;
/**
* Base interface for XML like serializers. Works both for IMicroNode and
* org.w3c.dom.Node objects.
*
* @author Philip Helger
* @param
* The node type to be serialized.
*/
public interface IXMLSerializer
{
/**
* Write the specified node to the specified {@link OutputStream}.
*
* @param aNode
* The node to write. May not be null.
* @param aOS
* The stream to serialize onto. May not be null.
*/
void write (@Nonnull NODETYPE aNode, @Nonnull @WillNotClose OutputStream aOS);
/**
* Write the specified node to the specified {@link Writer}.
*
* @param aNode
* The node to write. May not be null.
* @param aWriter
* The writer to serialize onto. May not be null.
*/
void write (@Nonnull NODETYPE aNode, @Nonnull @WillNotClose Writer aWriter);
}