src/main/java/com/google/android/libraries/feed/api/host/logging/InternalFeedError.java

// Copyright 2018 The Feed Authors.
//
// 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 com.google.android.libraries.feed.api.host.logging;

import android.support.annotation.IntDef;

/**
 * Represents internal errors of the Feed libraries.
 *
 * <p>When adding new values, the value of {@link InternalFeedError#NEXT_VALUE} should be used and
 * incremented. When removing values, {@link InternalFeedError#NEXT_VALUE} should not be changed,
 * and those values should not be reused.
 */
@IntDef({
  InternalFeedError.SWITCH_TO_EPHEMERAL,
  InternalFeedError.NO_URL_FOR_OPEN,
  InternalFeedError.FAILED_TO_RESTORE,
  InternalFeedError.NO_ROOT_FEATURE,
  InternalFeedError.TOP_LEVEL_UNBOUND_CHILD,
  InternalFeedError.TOP_LEVEL_INVALID_FEATURE_TYPE,
  InternalFeedError.CLUSTER_CHILD_MISSING_FEATURE,
  InternalFeedError.CLUSTER_CHILD_NOT_CARD,
  InternalFeedError.CARD_CHILD_MISSING_FEATURE,
  InternalFeedError.NULL_SHARED_STATES,
  InternalFeedError.FAILED_TO_CREATE_LEAF,
  InternalFeedError.UNHANDLED_TOKEN,
  InternalFeedError.TASK_QUEUE_STARVATION,
  InternalFeedError.NEXT_VALUE
})
public @interface InternalFeedError {

  /** Represents when memory fails so the Feed libraries switch to ephemeral mode. */
  int SWITCH_TO_EPHEMERAL = 0;

  /** Represents when opening a URL fails as there is no URL available. */
  int NO_URL_FOR_OPEN = 1;

  /** Represents a failure to restore. */
  int FAILED_TO_RESTORE = 2;

  /** Represents getting a session with no root feature. */
  int NO_ROOT_FEATURE = 3;

  /** Represents a top level child being unbound when initializing. */
  int TOP_LEVEL_UNBOUND_CHILD = 4;

  /** Represents a top level feature being neither a card nor a cluster. */
  int TOP_LEVEL_INVALID_FEATURE_TYPE = 5;

  /** Represents a child of a cluster not having a feature. */
  int CLUSTER_CHILD_MISSING_FEATURE = 6;

  /** Represents a child of a cluster not being a card. */
  int CLUSTER_CHILD_NOT_CARD = 7;

  /** Represents a child of a card not having a feature. */
  int CARD_CHILD_MISSING_FEATURE = 8;

  /** Represents a failure to load shared states for Piet content. */
  int NULL_SHARED_STATES = 9;

  /** Represents a failure to create a leaf child. */
  int FAILED_TO_CREATE_LEAF = 10;

  /** Represents a token that could not be handled. */
  int UNHANDLED_TOKEN = 11;

  /**
   * Represents that the task queue timed out waiting for a network request and began executing
   * queued tasks.
   */
  int TASK_QUEUE_STARVATION = 12;

  /** The next value that should be used when adding additional values to the IntDef. */
  int NEXT_VALUE = 13;
}