de.audioattack.io.ConsoleCreator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of console Show documentation

A replacement for java.io.Console with a System.in and System.out based fallback

There is a newer version: 1.2.1

/*
 * SPDX-FileCopyrightText: 2018 Marc Nause 
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package de.audioattack.io;

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.nio.charset.Charset;

/**
 * Creates an implementation of {@link Console de.audioattack.io.Console} which wraps
 * {@link java.io.Console java.io.Console} or which provides a fallback implementation
 * in case the former is not available.
 *
 * @since 1.0.0
 */
public final class ConsoleCreator {

    private static final Console CONSOLE = System.console() == null ? createCharacterDevice()
            : new ConsoleDevice(System.console());

    private ConsoleCreator() {
    }

    /**
     * Gets an implementation of {@link Console de.audioattack.io.Console}. Implementation based on
     * {@link java.io.Console java.io.Console} is preferred.
     *
     * @return the console
     */
    public static Console console() {
        return CONSOLE;
    }

    @SuppressWarnings("squid:S106")
    private static Console createCharacterDevice() {
        final BufferedReader reader = new BufferedReader(new InputStreamReader(System.in, Charset.defaultCharset()));
        final PrintWriter writer = new PrintWriter(new OutputStreamWriter(System.out, Charset.defaultCharset()), true);
        return new CharacterDevice(reader, writer);
    }
}