test_result_interfaces/com/android/tradefed/result/error/ErrorIdentifier.java

/*
 * Copyright (C) 2020 The Android Open Source Project
 *
 * 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.android.tradefed.result.error;

import com.android.tradefed.result.FailureDescription;
import com.android.tradefed.result.proto.TestRecordProto.FailureStatus;

/**
 * This interface describes a specific error and its properties.
 *
 * <p>Do not create implementation of this class outside of Trade Federation.
 */
public interface ErrorIdentifier {

    /** The name identifying the error. */
    public String name();

    /** The unique code identifying the error. */
    public long code();

    /**
     * The failure status associated with the identifier, this status is expected to align with the
     * {@link FailureDescription} one.
     */
    public FailureStatus status();
}