com.day.cq.rewriter.pipeline.Generator Maven / Gradle / Ivy

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.rewriter.pipeline;

import java.io.IOException;
import java.io.PrintWriter;

import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;

import com.day.cq.rewriter.processor.ProcessingComponentConfiguration;
import com.day.cq.rewriter.processor.ProcessingContext;


/**
 * The Generator interface defines the start of a rewriter pipeline.
 * @deprecated Use the Apache Sling Rewriter Module (org.apache.sling.rewriter.Generator)
 */
@Deprecated
public interface Generator {

    /**
     * Initialize this component.
     * @param context The invocation context.
     * @param config The configuration for this component.
     * @throws IOException {@link IOException}
     */
    void init(ProcessingContext context, ProcessingComponentConfiguration config)
    throws IOException;


    /**
     * Set the content handler the generator should stream to.
     * @param handler A transformer or serializer.
     */
    void setContentHandler(ContentHandler handler);

    /**
     * Get the writer to write the output to.
     * @return A print writer.
     */
    PrintWriter getWriter();

    /**
     * Notify the generator that parsing is finished.
     * @throws IOException {@link IOException}
     * @throws SAXException {@link SAXException}
     */
    void finished() throws IOException, SAXException;
}