PrintContainer.java

/*
 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
 *
 *  This file is licensed to You under the Eclipse Public License (EPL);
 *  You may not use this file except in compliance with the License. You
 *  may obtain a copy of the License at
 *
 *      http://www.opensource.org/licenses/eclipse-1.0.php
 *
 *  See the COPYRIGHT.txt file distributed with this work for information
 *  regarding copyright ownership.
 */
package org.jikesrvm;

import java.io.PrintStream;
import java.io.PrintWriter;
import org.jikesrvm.classloader.Atom;
import org.jikesrvm.classloader.RVMMember;

/**
 * The subclasses of PrintContainer all implement the {@link PrintLN}
 * interface.  They are used by our {@link java.lang.Throwable} to print stack
 * traces; it lets one use a single class to operate on {@link PrintWriter}
 * and {@link PrintStream} output streams and for the {@link VM#sysWrite}
 * output method.
 *
 * <p> We use it so we can print stack traces without having to provide
 * multiple versions of each method, one for each kind of output stream.
 */
public final class PrintContainer {
  /** Can not be instantiated. */
  private PrintContainer() {}

  /** Print via PrintWriter */
  private static class WithPrintWriter extends PrintLN {
    private PrintWriter out;

    WithPrintWriter(PrintWriter out) {
      this.out = out;
    }

    public void flush() {
      out.flush();
    }

    public void println() {
      out.println();
    }

    public void print(String s) {
      if (s == null) {
        s = "(*null String pointer*)";
      }
      out.print(s);
    }

    public void print(char c) {
      out.print(c);
    }
  }

  /** Print via PrintStream */
  private static class WithPrintStream extends PrintLN {
    private PrintStream out;

    WithPrintStream(PrintStream out) {
      this.out = out;
    }

    public boolean isSystemErr() {
      return this.out == System.err;
    }

    public void flush() {
      out.flush();
    }

    public void println() {
      out.println();
    }

    public void print(String s) {
      if (s == null) {
        s = "(*null String pointer*)";
      }
      out.print(s);
    }

    public void print(char c) {
      out.print(c);
    }
  }

  public static PrintLN get(PrintStream out) {
    return new WithPrintStream(out);
  }

  public static PrintLN get(PrintWriter out) {
    return new WithPrintWriter(out);
  }

  // Keep this one ready to go at all times :)
  public static final PrintLN readyPrinter = new WithSysWrite();

  /** This (nested) class does printing via {@link VM#sysWrite} */
  private static class WithSysWrite extends PrintLN {
    /** This doesn't carry any state, but we have a constructor so that we can
     * pass an instance of this to something expecting a {@link PrintLN} . */
    WithSysWrite() {}

    public boolean isSysWrite() {
      return true;
    }

    public void flush() {
    }

    public void println() {
      VM.sysWriteln();
    }

    public void print(String s) {
      if (s == null) {
        s = "(*null String pointer*)";
      }

      VM.sysWrite(s);
    }

    public void println(String s) {
      print(s);
      println();
    }

    public void print(int i) {
      VM.sysWrite(i);
    }

    public void printHex(int i) {
      VM.sysWriteHex(i);
    }

    public void print(char c) {
      VM.sysWrite(c);
    }

    public void print(RVMMember m) {
      VM.sysWrite(m);
    }

    public void print(Atom a) {
      VM.sysWrite(a);
    }
  }
}