/*
 * 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.apache.tsfile.external.commons.io.output;

import java.io.IOException;
import java.io.OutputStream;

/**
 * Never writes data. Calls never go beyond this class.
 *
 * <p>This output stream has no destination (file/socket etc.) and all bytes written to it are
 * ignored and lost.
 */
public class NullOutputStream extends OutputStream {

  /**
   * The singleton instance.
   *
   * @since 2.12.0
   */
  public static final NullOutputStream INSTANCE = new NullOutputStream();

  /**
   * The singleton instance.
   *
   * @deprecated Use {@link #INSTANCE}.
   */
  @Deprecated public static final NullOutputStream NULL_OUTPUT_STREAM = INSTANCE;

  /**
   * Deprecated in favor of {@link #INSTANCE}.
   *
   * <p>TODO: Will be private in 3.0.
   *
   * @deprecated Use {@link #INSTANCE}.
   */
  @Deprecated
  public NullOutputStream() {}

  /**
   * Does nothing - output to {@code /dev/null}.
   *
   * @param b The bytes to write
   * @throws IOException never
   */
  @Override
  public void write(final byte[] b) throws IOException {
    // To /dev/null
  }

  /**
   * Does nothing - output to {@code /dev/null}.
   *
   * @param b The bytes to write
   * @param off The start offset
   * @param len The number of bytes to write
   */
  @Override
  public void write(final byte[] b, final int off, final int len) {
    // To /dev/null
  }

  /**
   * Does nothing - output to {@code /dev/null}.
   *
   * @param b The byte to write
   */
  @Override
  public void write(final int b) {
    // To /dev/null
  }
}
