objectos.lang.NoOpNoteSink Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of objectos-lang Show documentation
Objectos Lang provides utilities for classes in the java.lang package.
There is a newer version: 0.8.0
/*
 * Copyright (C) 2022-2023 Objectos Software LTDA.
 *
 * Licensed 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 objectos.lang;

/**
 * A no-op {@code NoteSink} implementation (for the most part). The one
 * exception is the {@link NoteSink#replace(NoteSink)} operation that actually
 * returns the supplied value.
 *
 * @since 0.2
 */
public class NoOpNoteSink implements NoteSink {

  static final NoOpNoteSink INSTANCE = new NoOpNoteSink();

  /**
   * The sole {@code public} constructor.
   */
  public NoOpNoteSink() {}

  /**
   * Returns the {@code static} instance. This is method is provided as a
   * convenience and to avoid creating multiple instances of this instance.
   *
   * @return the {@code static} instance
   */
  public static NoOpNoteSink getInstance() {
    return INSTANCE;
  }

  /**
   * Returns {@code false}.
   *
   * @param note
   *        an note instance (ignored)
   *
   * @return {@code false}
   */
  @Override
  public boolean isEnabled(Note note) {
    return false;
  }

  /**
   * Returns the given {@code sink} value.
   *
   * @param sink
   *        a {@code NoteSink} instance
   *
   * @return the given {@code sink} value
   */
  @Override
  public final NoteSink replace(NoteSink sink) {
    Check.notNull(sink, "sink == null");

    return sink;
  }

  /**
   * Does nothing, this is a no-op sink.
   *
   * @param note
   *        an note instance (ignored)
   */
  @Override
  public void send(Note0 note) {
    // noop
  }

  /**
   * Does nothing, this is a no-op sink.
   *
   * @param note
   *        an note instance (ignored)
   * @param v1
   *        a value (ignored)
   */
  @Override
  public  void send(Note1 note, T1 v1) {
    // noop
  }

  /**
   * Does nothing, this is a no-op sink.
   *
   * @param note
   *        an note instance (ignored)
   * @param v1
   *        a first value (ignored)
   * @param v2
   *        a second value (ignored)
   */
  @Override
  public  void send(Note2 note, T1 v1, T2 v2) {
    // noop
  }

  /**
   * Does nothing, this is a no-op sink.
   *
   * @param note
   *        an note instance (ignored)
   * @param v1
   *        a first value (ignored)
   * @param v2
   *        a second value (ignored)
   * @param v3
   *        a third value (ignored)
   */
  @Override
  public  void send(Note3 note, T1 v1, T2 v2, T3 v3) {
    // noop
  }

}