001package org.apache.maven.doxia.module.itext;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.Writer;
023
024import org.apache.maven.doxia.sink.Sink;
025import org.apache.maven.doxia.sink.SinkFactory;
026import org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory;
027import org.codehaus.plexus.component.annotations.Component;
028import org.codehaus.plexus.util.WriterFactory;
029import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
030
031/**
032 * IText implementation of the Sink factory.
033 *
034 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
035 * @since 1.0
036 */
037@Component( role = SinkFactory.class, hint = "itext" )
038public class ITextSinkFactory
039    extends AbstractTextSinkFactory
040{
041    /** {@inheritDoc} */
042    protected Sink createSink( Writer writer, String encoding )
043    {
044        return new ITextSink( writer, encoding );
045    }
046
047    /**
048     * createSink.
049     *
050     * @param writer a {@link java.io.Writer} object.
051     * @return a {@link org.apache.maven.doxia.sink.Sink} object.
052     */
053    public Sink createSink( Writer writer )
054    {
055        // TODO: should this method be deprecated?
056        return createSink( writer, WriterFactory.UTF_8 );
057    }
058
059    /**
060     * Create a <code>Sink</code> into a PrettyPrintXMLWriter.
061     *
062     * @param xmlWriter not null XML writer to write the result.
063     * @return a <code>Sink</code> instance.
064     */
065    public Sink createSink( PrettyPrintXMLWriter xmlWriter )
066    {
067        if ( xmlWriter == null )
068        {
069            throw new IllegalArgumentException( "xmlWriter could not be null." );
070        }
071
072        return new ITextSink( xmlWriter );
073    }
074}