src.main.java.com.mebigfatguy.fbcontrib.debug.Debug Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sb-contrib Show documentation

An auxiliary findbugs.sourceforge.net plugin for java bug detectors that fall outside the narrow scope of detectors to be packaged with the product itself.

The newest version!

/*
 * fb-contrib - Auxiliary detectors for Java programs
 * Copyright (C) 2005-2019 Kevin Lubick
 * Copyright (C) 2005-2019 Dave Brosius
 *
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.mebigfatguy.fbcontrib.debug;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;

public final class Debug {

    private static PrintStream out;

    static {
        try {
            out = new PrintStream(new BufferedOutputStream(Files.newOutputStream(
                    Paths.get(System.getProperty("java.io.tmpdir"), "fb-contrib.txt"), StandardOpenOption.APPEND)),
                    false, StandardCharsets.UTF_8.name());
            out.println("===== fb-contrib console =====");
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    private Debug() {
    }

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

    public static void println(Object x) {
        out.println(x);
    }

    /**
     * Like println, but will print PC, if it's passed in
     *
     * e.g. Debug.println(getPC(), "Hello world"); will print [PC:42] Hello world
     *
     * @param pc  the program counter
     * @param obj the object to output
     */
    public static void println(int pc, Object obj) {
        out.printf("[PC:%d] %s%n", Integer.valueOf(pc), obj);
    }

}