鸿蒙OS ElementName

ElementName

java.lang.Object

|---ohos.bundle.ElementName

public class ElementName
extends Object
implements Sequenceable

包含基本的ability信息，它唯一地标识一个ability。

您可以使用此类获取元素中设置的字段的值，例如设备 ID、捆绑包名称和ability名称。

嵌套类摘要

从接口 ohos.utils.Sequenceable 继承的嵌套类/接口
Sequenceable.ProducerT

字段摘要

修饰符和类型	字段	描述
static Sequenceable.ProducerElementName	PRODUCER	Creates a ElementName instance from a Parcel.

构造函数摘要

构造函数	描述
ElementName()	用于创建 ElementName 实例的默认构造函数。
ElementName(String deviceId, String bundleName, String abilityName)	用于创建 ElementName 实例的参数化构造函数。
ElementName(ElementName elementName)	一种参数化构造函数，用于通过从现有参数复制参数来创建 ElementName 实例。

方法总结

修饰符和类型	方法	描述
static ElementName	createRelative(String bundleName, String abilityName, String deviceId)	创建另一个 ElementName 实例，其中ability的类名称以包名称为前缀。
boolean	equals(Object object)	检查两个 ElementName 对象是否包含相同的属性。
String	getAbilityName()	获得ability的名称。
String	getBundleName()	获取ability的捆绑包名称。
String	getDeviceId()	获取ability的唯一设备ID。
String	getShortClassName()	获取当前 ElementName 实例中ability的短类名。
String	getURI()	获取ability的URI。
int	hashCode()	计算 ElementName 对象的哈希值。
boolean	marshalling(Parcel out)	将此 Sequenceable 对象编组为 Parcel。
void	setAbilityName(String name)	设置ability名称。
void	setBundleName(String bundleName)	设置ability的捆绑包名称。
void	setDeviceId(String deviceId)	设置设备ID
static ElementName	unflattenFromString(String elementName)	从使用 getURI() 创建的字符串中恢复 ElementName 实例。
boolean	unmarshalling(Parcel in)	从 Parcel 中解组此 Sequenceable 对象。

从类 java.lang.Object 继承的方法
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口 ohos.utils.Sequenceable 继承的方法
hasFileDescriptor

字段详情

PRODUCER

public static final Sequenceable.ProducerElementName PRODUCER

从 Parcel 创建一个 ElementName 实例。

构造函数详细信息

ElementName

public ElementName()

用于创建 ElementName 实例的默认构造函数。

ElementName

public ElementName(String deviceId, String bundleName, String abilityName)

用于创建 ElementName 实例的参数化构造函数。

参数:

参数名称	参数描述
deviceId	表示运行指定ability的设备的ID。
bundleName	表示指定ability所属的捆绑包的名称。
abilityName	表示ability名称。

ElementName

public ElementName(ElementName elementName)

一种参数化构造函数，用于通过从现有参数复制参数来创建 ElementName 实例。

参数:

参数名称	参数描述
elementName	指示 ElementName 对象。

方法详情

getDeviceId

public String getDeviceId()

获取技能的唯一设备ID。

返回:

返回能力的唯一设备 ID。

setDeviceId

public void setDeviceId(String deviceId)

设置设备ID

参数:

参数名称	参数描述
deviceId	表示设备ID。 一项ability只有一个设备 ID。

Since:

1

getAbilityName

public String getAbilityName()

获得ability的名称。

返回:

返回ability的名称。

setAbilityName

public void setAbilityName(String name)

设置ability名称

参数:

参数名称	参数描述
name	表示ability的名称。

getBundleName

public String getBundleName()

获取ability的捆绑包名称。

返回:

返回ability的捆绑包名称。

setBundleName

public void setBundleName(String bundleName)

设置ability的捆绑包名称。

参数:

参数名称	参数描述
bundleName	指示ability的捆绑包名称。

getURI

public String getURI()

获取ability的URI。

ability的 URI 由 deviceId、bundleName 和ability名称属性确定。

返回:

返回ability的 URI。

marshalling

public boolean marshalling(Parcel out)

从接口复制的描述：Sequenceable

将此 Sequenceable 对象编组为 Parcel。

指定者：

接口 Sequenceable 中的编组

参数:

参数名称	参数描述
out	指示将 Sequenceable 对象编组到的 Parcel 对象。

返回:

如果编组成功，则返回 true； 否则返回 false。

unmarshalling

public boolean unmarshalling(Parcel in)

从接口复制的描述：Sequenceable

从 Parcel 中解组此 Sequenceable 对象。

指定者：

在接口 Sequenceable 中解组

参数:

参数名称	参数描述
in	指示已将 Sequenceable 对象编组到的 Parcel 对象。

返回:

如果解组成功，则返回 true； 否则返回 false。

equals

public boolean equals(Object object)

检查两个 ElementName 对象是否包含相同的属性。

ElementName 包含应用程序查询ability所需的信息。 此类包含应用程序的abilityName、bundleName 和 deviceId 属性。

覆盖：

类 Object 中的等于

参数:

参数名称	参数描述
object	指示要比较的 ElementName 对象。

返回:

如果两个 ElementName 对象包含相同的属性，则返回 true； 否则返回 false。

hashCode

public int hashCode()

计算 ElementName 对象的哈希值。

ElementName 对象的哈希值是根据 deviceId、bundleName 和abilityName 属性计算的。

覆盖：

类 Object 中的 hashCode

返回:

返回 ElementName 对象的哈希值。

createRelative

public static ElementName createRelative(String bundleName, String abilityName, String deviceId)

创建另一个 ElementName 实例，其中ability的类名称以包名称为前缀。

参数:

参数名称	参数描述
bundleName	表示指定ability所属的捆绑包的名称。 此参数不能为空。
abilityName	表示ability的类名。 此参数不能为空。
deviceId	表示运行指定ability的设备的ID。

返回:

返回创建的 ElementName 实例。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 abilityName 为 null 或空字符串，则引发此异常。

getShortClassName

public String getShortClassName()

获取当前 ElementName 实例中ability的短类名。

短类名不以包名为前缀。 相反，它以句点 (.) 开头，例如 .MainAbility。

返回:

返回当前 ElementName 实例中ability的短类名称。

unflattenFromString

public static ElementName unflattenFromString(String elementName)

从使用 getURI() 创建的字符串中恢复 ElementName 实例。

该字符串必须采用 deviceId/bundleName/abilityName 格式，例如 deviceId1/com.abc.hiword/com.abc.hiword.MainAbility。

参数:

参数名称	参数描述
elementName	表示元素名称的字符串，从getURI()中获取。 此参数不能为空。

返回:

返回一个 ElementName 实例。

Throws:

Throw名称	Throw描述
IllegalArgumentException	如果 elementName 为 null 或不是指定格式，则引发此异常。