org.netbeans.api.io.OutputWriter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.netbeans.api.io;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Locale;
import java.util.Set;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.spi.io.InputOutputProvider;
/**
* Extended {@link PrintWriter} for writing into output window or similar output
* GUI component. It can support features like color printing, hyperlinks, or
* folding.
*
*
* Methods of this class can be called in any thread.
*
*
* @author jhavlin
*/
public abstract class OutputWriter extends PrintWriter {
private OutputWriter() {
super(new DummyWriter());
}
/**
* Get current position in the output stream.
*
* @return The position.
*/
public abstract Position getCurrentPosition();
/**
* Start a new fold. If a fold already exists, a nested fold will be
* created.
*
* @param expanded True if the fold should be expanded by default, false if
* it should be collapsed.
*
* @return The fold handle.
*/
public abstract Fold startFold(boolean expanded);
/**
* Finish a fold. If it contains some unfinished nested folds, they will be
* finished as well.
*
* @param fold The fold to finish.
*/
public abstract void endFold(Fold fold);
public abstract void print(String s, Hyperlink link, OutputColor color);
public abstract void print(String s, Hyperlink link);
public abstract void print(String s, OutputColor color);
public abstract void println(String s, Hyperlink link, OutputColor color);
public abstract void println(String s, Hyperlink link);
public abstract void println(String s, OutputColor color);
static OutputWriter create(
InputOutputProvider provider, IO io, OW writer) {
return new Impl(provider, io, writer);
}
private static class Impl
extends OutputWriter {
private final InputOutputProvider provider;
private final IO io;
private final OW writer;
public Impl(InputOutputProvider provider,
IO io, OW writer) {
this.provider = provider;
this.io = io;
this.writer = writer;
}
@Override
public Position getCurrentPosition() {
return Position.create(provider, io, writer,
provider.getCurrentPosition(io, writer));
}
@Override
public void print(String s, Hyperlink link, OutputColor color) {
provider.print(io, writer, s, link, color, false);
}
@Override
public void print(String s, Hyperlink link) {
provider.print(io, writer, s, link, null, false);
}
@Override
public void print(String s, OutputColor color) {
provider.print(io, writer, s, null, color, false);
}
@Override
public void println(String s, Hyperlink link, OutputColor color) {
provider.print(io, writer, s, link, color, true);
}
@Override
public void println(String s, Hyperlink link) {
provider.print(io, writer, s, link, null, true);
}
@Override
public void println(String s, OutputColor color) {
provider.print(io, writer, s, null, color, true);
}
@Override
public void flush() {
writer.flush();
}
@Override
public void close() {
writer.close();
}
@Override
public boolean checkError() {
return writer.checkError();
}
@Override
public void write(int c) {
writer.write(c);
}
@Override
public void write(char[] buf, int off, int len) {
writer.write(buf, off, len);
}
@Override
public void write(char[] buf) {
writer.write(buf);
}
@Override
public void write(String s, int off, int len) {
writer.write(s, off, len);
}
@Override
public void write(String s) {
writer.write(s);
}
@Override
public void print(boolean b) {
writer.print(b);
}
@Override
public void print(char c) {
writer.print(c);
}
@Override
public void print(int i) {
writer.print(i);
}
@Override
public void print(long l) {
writer.print(l);
}
@Override
public void print(float f) {
writer.print(f);
}
@Override
public void print(double d) {
writer.print(d);
}
@Override
@SuppressWarnings("ImplicitArrayToString")
public void print(char[] s) {
writer.print(s);
}
@Override
public void print(String s) {
writer.print(s);
}
@Override
public void print(Object obj) {
writer.print(obj);
}
@Override
public void println() {
writer.println();
}
@Override
public void println(boolean x) {
writer.println(x);
}
@Override
public void println(char x) {
writer.println(x);
}
@Override
public void println(int x) {
writer.println(x);
}
@Override
public void println(long x) {
writer.println(x);
}
@Override
public void println(float x) {
writer.println(x);
}
@Override
public void println(double x) {
writer.println(x);
}
@Override
@SuppressWarnings("ImplicitArrayToString")
public void println(char[] x) {
writer.println(x);
}
@Override
public void println(String x) {
writer.println(x);
}
@Override
public void println(Object x) {
writer.println(x);
}
@Override
public PrintWriter printf(String format, Object... args) {
return writer.printf(format, args);
}
@Override
public PrintWriter printf(Locale l, String format, Object... args) {
return writer.printf(l, format, args);
}
@Override
public PrintWriter format(String format, Object... args) {
return writer.format(format, args);
}
@Override
public PrintWriter format(Locale l, String format, Object... args) {
return writer.format(l, format, args);
}
@Override
public PrintWriter append(CharSequence csq) {
return writer.append(csq);
}
@Override
public PrintWriter append(CharSequence csq, int start, int end) {
return writer.append(csq, start, end);
}
@Override
public PrintWriter append(char c) {
return writer.append(c);
}
@Override
public Fold startFold(boolean expanded) {
F fold = provider.startFold(io, writer, expanded);
return Fold.create(provider, io, writer, fold);
}
@Override
public void endFold(Fold fold) {
if (fold != Fold.UNSUPPORTED) {
fold.endFold();
}
}
}
private static class DummyWriter extends Writer {
@Override
public void write(char[] cbuf, int off, int len) throws IOException {
}
@Override
public void flush() throws IOException {
}
@Override
public void close() throws IOException {
}
}
}