/*
 * Copyright 2017, Google Inc.
 * 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 io.opencensus.stats;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

/**
 * Class that holds the implementations for {@link ViewManager}, {@link StatsRecorder}, and {@link
 * StatsContextFactory}.
 *
 * <p>All objects returned by methods on {@code StatsComponent} are cacheable.
 */
public abstract class StatsComponent {
  private static final StatsComponent NOOP_STATS_COMPONENT = new NoopStatsComponent();

  /** Returns the default {@link ViewManager}. */
  @Nullable
  public abstract ViewManager getViewManager();

  /** Returns the default {@link StatsRecorder}. */
  public abstract StatsRecorder getStatsRecorder();

  /** Returns the default {@link StatsContextFactory}. */
  // TODO(sebright): Remove this method once StatsContext is replaced by TagContext.
  @Nullable
  abstract StatsContextFactory getStatsContextFactory();

  /**
   * Returns a {@code StatsComponent} that has a no-op implementation for the {@link StatsRecorder}.
   *
   * @return a {@code StatsComponent} that has a no-op implementation for the {@code StatsRecorder}.
   */
  static StatsComponent getNoopStatsComponent() {
    return NOOP_STATS_COMPONENT;
  }

  @Immutable
  private static final class NoopStatsComponent extends StatsComponent {

    @Override
    @Nullable
    public ViewManager getViewManager() {
      return null;
    }

    @Override
    public StatsRecorder getStatsRecorder() {
      return StatsRecorder.getNoopStatsRecorder();
    }

    @Override
    @Nullable
    StatsContextFactory getStatsContextFactory() {
      return null;
    }
  }
}

/*
 * Copyright 2017, Google Inc.
 * 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 io.opencensus.stats;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

/**
 * Class that holds the implementations for {@link ViewManager}, {@link StatsRecorder}, and {@link
 * StatsContextFactory}.
 *
 * <p>All objects returned by methods on {@code StatsComponent} are cacheable.
 */
public abstract class StatsComponent {
  private static final StatsComponent NOOP_STATS_COMPONENT = new NoopStatsComponent();

  /** Returns the default {@link ViewManager}. */
  @Nullable
  public abstract ViewManager getViewManager();

  /** Returns the default {@link StatsRecorder}. */
  public abstract StatsRecorder getStatsRecorder();

  /** Returns the default {@link StatsContextFactory}. */
  // TODO(sebright): Remove this method once StatsContext is replaced by TagContext.
  @Nullable
  abstract StatsContextFactory getStatsContextFactory();

  /**
   * Returns a {@code StatsComponent} that has a no-op implementation for the {@link StatsRecorder}.
   *
   * @return a {@code StatsComponent} that has a no-op implementation for the {@code StatsRecorder}.
   */
  static StatsComponent getNoopStatsComponent() {
    return NOOP_STATS_COMPONENT;
  }

  @Immutable
  private static final class NoopStatsComponent extends StatsComponent {

    @Override
    @Nullable
    public ViewManager getViewManager() {
      // TODO(sebright): Decide whether to also provide a no-op implementation for the ViewManager.
      return null;
    }

    @Override
    public StatsRecorder getStatsRecorder() {
      return StatsRecorder.getNoopStatsRecorder();
    }

    @Override
    @Nullable
    StatsContextFactory getStatsContextFactory() {
      return null;
    }
  }
}

Add TODO about creating a no-op ViewManager.