org.docx4j.convert.out.common.Writer Maven / Gradle / Ivy

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

docx4j is a library which helps you to work with the Office Open XML file format as used in docx documents, pptx presentations, and xlsx spreadsheets.

There is a newer version: 11.4.11

Show newest version

/*
   Licensed to Plutext Pty Ltd under one or more contributor license agreements.  
   
 *  This file is part of docx4j.

    docx4j is 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 org.docx4j.convert.out.common;

import javax.xml.transform.TransformerException;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

/**
 * Note that Writer(s) must be 
 * registered in the corresponding instance (FO, HTML...)
 * of the WriterRegistry. Writers are Singletons and shouldn't
 * keep any state.
 */
public interface Writer {
	/** Tag interface for a transform state that may be used by the Writer 
	 */
	public interface TransformState {
	}
	
	/** Return the common ID of the Model/Converter/TransformState.  
	 * 
	 * @return
	 */
	public String getID();
	
	/** Generate the corresponding document fragment
	 * 
	 * @param context
	 * @param model
	 * @param state
	 * @param doc
	 * @return
	 * @throws TransformerException
	 */
	public Node toNode(AbstractWmlConversionContext context, Object unmarshalledNode, Node content, TransformState state, Document doc) throws TransformerException;

	/** Create a new instance of the TransformState it uses.

	 *  It may return null, then the passed value in toNode will be null.  
	 * 
	 * @return
	 */
	public TransformState createTransformState();
}