public final class NdefMessage
extends Object
implements Parcelable
java.lang.Object | |
↳ | android.nfc.NdefMessage |
代表不可变的NDEF消息。
NDEF(NFC数据交换格式)是一种轻量级二进制格式,用于封装类型化数据。 它由NFC论坛规定,用于与NFC进行传输和存储,但是它与传输无关。
NDEF定义消息和记录。 NDEF记录包含类型化数据,例如MIME类型媒体,URI或自定义应用程序有效内容。 NDEF消息是一个或多个NDEF记录的容器。
当Android设备收到NDEF消息(例如通过读取NFC标签)时,它会通过分发机制处理它以确定要启动的活动。 消息中第一条记录的类型对于消息调度具有特别的重要性,因此请仔细设计此记录。
使用 NdefMessage(byte[])
从二进制数据构建NDEF消息,或使用 NdefMessage(NdefRecord[])
从一个或多个 NdefRecord
。
NdefMessage
和 NdefRecord
实现始终可用,即使在没有NFC硬件的Android设备上也是如此。
NdefRecord
旨在是不可变的(并且是线程安全的),但它们可能包含可变字段。 因此,注意不要修改传入构造函数的可变字段,也不要修改getter方法获得的可变字段,除非这些修改明确标记为安全。
也可以看看:
Inherited constants |
---|
From interface android.os.Parcelable
|
Fields |
|
---|---|
public static final Creator<NdefMessage> |
CREATOR |
Public constructors |
|
---|---|
NdefMessage(byte[] data) 通过解析原始字节构造NDEF消息。 |
|
NdefMessage(NdefRecord record, NdefRecord... records) 从一个或多个NDEF记录构建NDEF消息。 |
|
NdefMessage(NdefRecord[] records) 从一个或多个NDEF记录构建NDEF消息。 |
Public methods |
|
---|---|
int |
describeContents() 描述此Parcelable实例的封送表示中包含的特殊对象的种类。 |
boolean |
equals(Object obj) 如果指定的NDEF消息包含相同的NDEF记录,则返回true。 |
int |
getByteArrayLength() 如果将该NDEF消息写入具有 |
NdefRecord[] |
getRecords() 在NDEF消息中获取NDEF记录。 |
int |
hashCode() 返回对象的哈希码值。 |
byte[] |
toByteArray() 以原始字节返回此NDEF消息。 |
String |
toString() 返回对象的字符串表示形式。 |
void |
writeToParcel(Parcel dest, int flags) 将此对象平铺到一个包裹中。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
|
From interface android.os.Parcelable
|
NdefMessage (byte[] data)
通过解析原始字节构造NDEF消息。
执行严格的NDEF二进制结构验证:必须至少有一条记录,每条记录标志必须正确,并且消息的总长度必须与输入数据的长度相匹配。
该解析器可以处理分块记录,并将它们转换为消息内的逻辑 NdefRecord
。
一旦输入数据被解析为一个或多个逻辑记录,就会按照 NdefRecord(short, byte[], byte[], byte[])
上的文档对每个记录的tnf,type,id和payload字段进行基本验证
如果严格验证二进制格式失败,或者在记录构建过程中进行基本验证失败,则抛出 FormatException
不对每个记录的类型,id和有效负载字段进行深入检查,因此可以解析具有有效二进制格式的输入,并确认基本验证要求 NdefRecord(short, byte[], byte[], byte[])
,但不符合NFC指定的更严格要求论坛。
在构建完成后重新使用数据字节数组是安全的:这个构造函数将创建所有必要字段的内部副本。
Parameters | |
---|---|
data |
byte : raw bytes to parse |
Throws | |
---|---|
FormatException |
if the data cannot be parsed |
NdefMessage (NdefRecord record, NdefRecord... records)
从一个或多个NDEF记录构建NDEF消息。
Parameters | |
---|---|
record |
NdefRecord : first record (mandatory) |
records |
NdefRecord : additional records (optional) |
NdefMessage (NdefRecord[] records)
从一个或多个NDEF记录构建NDEF消息。
Parameters | |
---|---|
records |
NdefRecord : one or more records |
int describeContents ()
描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如,如果对象将在writeToParcel(Parcel, int)
的输出中包含writeToParcel(Parcel, int)
,则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR
位。
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
boolean equals (Object obj)
如果指定的NDEF消息包含相同的NDEF记录,则返回true。
Parameters | |
---|---|
obj |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj argument; false otherwise. |
int getByteArrayLength ()
如果将该NDEF消息写入到 toByteArray()
的字节数组中,则返回该长度。
根据分块,SR和ID标志,NDEF消息可以以不同的方式格式化为字节,所以此方法返回的长度可能不等于用于构造此NDEF消息的原始字节数组的长度。 但是它将始终等于由toByteArray()
生成的字节数组的长度。
Returns | |
---|---|
int |
length of this NDEF Message when written to bytes with toByteArray() |
也可以看看:
NdefRecord[] getRecords ()
在NDEF消息中获取NDEF记录。
一个 NdefMessage
总是有一个或多个NDEF记录:所以下面的代码检索第一个记录总是安全的(不需要检查null或数组长度> = 1):
NdefRecord firstRecord = ndefMessage.getRecords()[0];
Returns | |
---|---|
NdefRecord[] |
array of one or more NDEF records. |
int hashCode ()
返回对象的哈希码值。 为了散列表的好处而支持该方法,例如由HashMap
提供的HashMap
。
hashCode
的总合同是:
hashCode
method must consistently return the same integer, provided no information used in equals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. equals(Object)
method, then calling the hashCode
method on each of the two objects must produce the same integer result. equals(java.lang.Object)
method, then calling the hashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. 尽可能合理实用,由类Object
定义的hashCode方法确实为不同的对象返回不同的整数。 (这通常通过将对象的内部地址转换为整数来实现,但Java TM编程语言不需要此实现技术。)
Returns | |
---|---|
int |
a hash code value for this object. |
byte[] toByteArray ()
以原始字节返回此NDEF消息。
NDEF消息根据NDEF 1.0规范进行格式化,字节数组适用于NFC论坛NDEF兼容标签中的网络传输或存储。
此方法不会分块记录,并且将始终使用短记录(SR)格式,并尽可能省略标识符字段。
Returns | |
---|---|
byte[] |
NDEF Message in binary format |
也可以看看:
String toString ()
返回对象的字符串表示形式。 通常, toString
方法将返回一个“文本表示”此对象的字符串。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。
类Object
的toString
方法返回一个字符串,其中包含对象为实例的类的名称,符号字符“ @
”以及对象的哈希代码的无符号十六进制表示形式。 换句话说,这个方法返回一个字符串,其值等于:
getClass().getName() + '@' + Integer.toHexString(hashCode())
Returns | |
---|---|
String |
a string representation of the object. |
void writeToParcel (Parcel dest, int flags)
将此对象平铺到一个包裹中。
Parameters | |
---|---|
dest |
Parcel : The Parcel in which the object should be written. |
flags |
int : Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . |