framework/java/android/nfc/NfcRoutingTableEntry.java

/*
 * Copyright (C) 2024 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 android.nfc;


import android.annotation.FlaggedApi;
import android.annotation.IntDef;
import android.annotation.SystemApi;
import android.nfc.cardemulation.CardEmulation;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Class to represent an entry of routing table. This class is abstract and extended by
 * {@link RoutingTableTechnologyEntry}, {@link RoutingTableProtocolEntry},
 * {@link RoutingTableAidEntry} and {@link RoutingTableSystemCodeEntry}.
 *
 * @hide
 */
@FlaggedApi(Flags.FLAG_NFC_OEM_EXTENSION)
@SystemApi
public abstract class NfcRoutingTableEntry {
    private final int mNfceeId;
    private final int mType;
    private final int mRouteType;

    /**
     * AID routing table type.
     */
    public static final int TYPE_AID = 0;
    /**
     * Protocol routing table type.
     */
    public static final int TYPE_PROTOCOL = 1;
    /**
     * Technology routing table type.
     */
    public static final int TYPE_TECHNOLOGY = 2;
    /**
     * System Code routing table type.
     */
    public static final int TYPE_SYSTEM_CODE = 3;

    /**
     * Possible type of this routing table entry.
     * @hide
     */
    @IntDef(prefix = "TYPE_", value = {
            TYPE_AID,
            TYPE_PROTOCOL,
            TYPE_TECHNOLOGY,
            TYPE_SYSTEM_CODE
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface RoutingTableType {}

    /** @hide */
    protected NfcRoutingTableEntry(int nfceeId, @RoutingTableType int type,
            @CardEmulation.ProtocolAndTechnologyRoute int routeType) {
        mNfceeId = nfceeId;
        mType = type;
        mRouteType = routeType;
    }

    /**
     * Gets the NFCEE Id of this entry.
     * @return an integer of NFCEE Id.
     */
    public int getNfceeId() {
        return mNfceeId;
    }

    /**
     * Get the type of this entry.
     * @return an integer defined in {@link RoutingTableType}
     */
    @RoutingTableType
    public int getType() {
        return mType;
    }

    /**
     * Get the route type of this entry.
     * @return an integer defined in
     * {@link android.nfc.cardemulation.CardEmulation.ProtocolAndTechnologyRoute}
     */
    @CardEmulation.ProtocolAndTechnologyRoute
    public int getRouteType() {
        return mRouteType;
    }
}