org.xwiki.rendering.renderer.printer.DefaultWikiPrinter Maven / Gradle / Ivy
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.rendering.renderer.printer;
/**
* Printer using a {@link StringBuffer} as the underlying output target.
*
* @version $Id: 4f0769c6cf8b069a824c7bf4ff363de8196e8225 $
* @since 1.6M1
*/
public class DefaultWikiPrinter implements WikiPrinter
{
/**
* The buffer where to put the provided {@link String}s.
*/
private StringBuffer buffer;
/**
* The default constructor. It initialize a new empty {@link StringBuffer}.
*/
public DefaultWikiPrinter()
{
this(new StringBuffer());
}
/**
* @param buffer the {@link StringBuffer} to where to put the provided {@link String}s.
*/
public DefaultWikiPrinter(StringBuffer buffer)
{
this.buffer = buffer;
}
/**
* @return the buffer containing the printed {@link String}s.
*/
public StringBuffer getBuffer()
{
return this.buffer;
}
/**
* This method is protected to allow classes extending this one to override what a new line is.
*
* @return a new line symbols
*/
protected String getEOL()
{
return "\n";
}
@Override
public void print(String text)
{
getBuffer().append(text);
}
@Override
public void println(String text)
{
getBuffer().append(text).append(getEOL());
}
@Override
public String toString()
{
return getBuffer().toString();
}
/**
* Removes the buffer's content which allows the printer to be reused.
*/
public void clear()
{
getBuffer().setLength(0);
}
}