com.oracle.bedrock.runtime.java.io.NullWriter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of bedrock-runtime Show documentation

Interfaces, classes and resources to construct, inspect and manage runtime processes.

There is a newer version: 7.0.3

/*
 * File: NullWriter.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of 
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.bedrock.runtime.java.io;

import java.io.IOException;
import java.io.Writer;
import java.util.concurrent.atomic.AtomicBoolean;

/**
 * A {@link java.io.Writer} that discards of all output sent to it.
 * 
 * Copyright (c) 2013. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
public class NullWriter extends Writer
{
    /**
     * Has the Writer been closed?
     */
    private AtomicBoolean closed;


    /**
     * Constructs a {@link NullWriter}.
     */
    public NullWriter()
    {
        super();
        closed = new AtomicBoolean(false);
    }


    @Override
    public void close() throws IOException
    {
        closed.set(true);
    }


    @Override
    public void flush() throws IOException
    {
        if (closed.get())
        {
            throw new IOException("NullWriter is closed");
        }
    }


    @Override
    public void write(char[] chars,
                      int    i,
                      int    i2) throws IOException
    {
        if (closed.get())
        {
            throw new IOException("NullWriter is closed");
        }
    }
}