dorkbox.console.output.AnsiRenderWriter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2009 the original author(s).
 *
 * 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 dorkbox.console.output;

import static dorkbox.console.output.AnsiRenderer.render;

import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Locale;

/**
 * Print writer which supports automatic ANSI color rendering via {@link AnsiRenderer}.
 *
 * @author Jason Dillon
 * @author Hiram Chirino
 * @since 1.1
 */
public
class AnsiRenderWriter extends PrintWriter {

    public
    AnsiRenderWriter(final OutputStream out) {
        super(out);
    }

    public
    AnsiRenderWriter(final OutputStream out, final boolean autoFlush) {
        super(out, autoFlush);
    }

    public
    AnsiRenderWriter(final Writer out) {
        super(out);
    }

    public
    AnsiRenderWriter(final Writer out, final boolean autoFlush) {
        super(out, autoFlush);
    }

    @Override
    public
    void write(final String s) {
        if (s != null && s.contains(AnsiRenderer.BEGIN_TOKEN)) {
            super.write(render(s));
        }
        else {
            super.write(s);
        }
    }

    @Override
    public
    PrintWriter format(final String format, final Object... args) {
        flush(); // prevents partial output from being written while formatting or we will get rendering exceptions
        print(String.format(format, args));
        return this;
    }

    @Override
    public
    PrintWriter format(final Locale l, final String format, final Object... args) {
        flush(); // prevents partial output from being written while formatting or we will get rendering exceptions
        print(String.format(l, format, args));
        return this;
    }
}