Nick Pelly | c84c89a | 2011-08-22 22:27:11 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2011 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.nfc; |
| 18 | |
| 19 | /** |
| 20 | * Wraps information associated with any NFC event. |
| 21 | * |
| 22 | * <p>Immutable object, with direct access to the (final) fields. |
| 23 | * |
| 24 | * <p>An {@link NfcEvent} object is usually included in callbacks from |
| 25 | * {@link NfcAdapter}. Check the documentation of the callback to see |
| 26 | * which fields may be set. |
| 27 | * |
| 28 | * <p>This wrapper object is used (instead of parameters |
| 29 | * in the callback) because it allows new fields to be added without breaking |
| 30 | * API compatibility. |
| 31 | * |
Scott Main | 2d68a6b | 2011-09-26 22:59:38 -0700 | [diff] [blame] | 32 | * @see NfcAdapter.OnNdefPushCompleteCallback#onNdefPushComplete |
| 33 | * @see NfcAdapter.CreateNdefMessageCallback#createNdefMessage |
Nick Pelly | c84c89a | 2011-08-22 22:27:11 -0700 | [diff] [blame] | 34 | */ |
| 35 | public final class NfcEvent { |
| 36 | /** |
| 37 | * The {@link NfcAdapter} associated with the NFC event. |
| 38 | */ |
| 39 | public final NfcAdapter nfcAdapter; |
| 40 | |
| 41 | NfcEvent(NfcAdapter nfcAdapter) { |
| 42 | this.nfcAdapter = nfcAdapter; |
| 43 | } |
| 44 | } |