InnerEvent

java.lang.Object
- ohos.eventhandler.InnerEvent

所有已实现的接口:

Sequenceable
```
public final class InnerEvent
extends Object
implements Sequenceable
```
Defines the structure of an event that can be sent to EventHandler.
An InnerEvent object contains an extra integer field and an extra object field to carry specific data.
The constructor of InnerEvent is private. Therefore, you need to call the get() method to create an InnerEvent instance. The method will pull InnerEvent instances from a pool of recycled objects.

从以下版本开始:

1

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`int`	`eventId`	Indicates the event ID, which identifies the event type and determines the event handler.
`Object`	`object`	Indicates the object carried in an `InnerEvent` for passing data of any type.
`long`	`param`	Indicates the long integer data carried in an `InnerEvent`, which is used to pass simple data.
`static Sequenceable.Producer<InnerEvent>`	`PRODUCER`	Creates a `InnerEvent` instance from a `Parcel`.
`Courier`	`replyTo`	Indicates the `Courier` where replies to this inner event can be sent.
`int`	`sendingUid`	Indicates the UID sending the inner event.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static InnerEvent`	`copyFrom(InnerEvent oldInnerEvent)`	Creates an `InnerEvent` by copying task, ID, and other information from an existing `InnerEvent`.
`void`	`drop()`	Releases an `InnerEvent` instance.
`static InnerEvent`	`get()`	Obtains an `InnerEvent` instance.
`static InnerEvent`	`get(int eventId)`	Obtains an `InnerEvent` instance with the event ID specified.
`static InnerEvent`	`get(int eventId, long param)`	Obtains an `InnerEvent` instance with the event ID and long integer data specified.
`static InnerEvent`	`get(int eventId, long param, Object object)`	Obtains an `InnerEvent` instance with the event ID and required data specified.
`static InnerEvent`	`get(int eventId, Object object)`	Obtains an `InnerEvent` instance with the event ID and object specified.
`static InnerEvent`	`get(Runnable task)`	Obtains an `InnerEvent` instance that carries a specified task.
`static InnerEvent`	`get(InnerEvent oldInnerEvent)`	Clones an `InnerEvent` instance by copying the event ID, task, owner, and other information of an existing `InnerEvent` instance to it.
`long`	`getHandleTime()`	Obtains the time when this `InnerEvent` was delivered.
`PacMap`	`getPacMap()`	Obtains the `PacMap` object contained in this `InnerEvent` or a new `PacMap` object.
`Runnable`	`getTask()`	Obtains the `Runnable` task that will be executed when this `InnerEvent` is handled.
`boolean`	`isPriorityEqual(EventHandler.Priority priority)`	Checks whether the priority of this `InnerEvent` is the same as the given priority.
`boolean`	`marshalling(Parcel out)`	Marshals this `Sequenceable` object into a `Parcel`.
`PacMap`	`peekPacMap()`	Obtains the `PacMap` object contained in this `InnerEvent`.
`void`	`setPacMap(PacMap pacMap)`	Sets a `PacMap` object in this `InnerEvent`.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `Sequenceable` object from a `Parcel`.

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

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

- 字段详细资料
  - PRODUCER
```
public static final Sequenceable.Producer<InnerEvent> PRODUCER
```
    Creates a InnerEvent instance from a Parcel.
    
    从以下版本开始:
    
    4
  - eventId
```
public int eventId
```
    Indicates the event ID, which identifies the event type and determines the event handler.
    Each EventHandler has a unique namespace for storing event IDs. Therefore, event IDs of different EventHandler objects do not affect each other even if the IDs are the same.
    
    从以下版本开始:
    
    1
  - object
```
public Object object
```
    Indicates the object carried in an InnerEvent for passing data of any type. It is usually used to pass complex data.
    
    从以下版本开始:
    
    1
  - param
```
public long param
```
    Indicates the long integer data carried in an InnerEvent, which is used to pass simple data.
    
    从以下版本开始:
    
    1
  - replyTo
```
public Courier replyTo
```
    Indicates the Courier where replies to this inner event can be sent.
    
    从以下版本开始:
    
    3
  - sendingUid
```
public int sendingUid
```
    Indicates the UID sending the inner event. This is valid only for events sent by a Courier. Otherwise, the value is -1.
    
    从以下版本开始:
    
    3
- 方法详细资料
  - isPriorityEqual
```
public boolean isPriorityEqual(EventHandler.Priority priority)
```
    Checks whether the priority of this InnerEvent is the same as the given priority.
    
    参数:
    
    priority - Indicates the event priority.
    
    返回:
    
    Returns true if the priority of this event is the same as the given priority; returns false otherwise.
    
    从以下版本开始:
    
    4
  - get
```
public static InnerEvent get()
```
    Obtains an InnerEvent instance.
    
    返回:
    
    Returns an InnerEvent instance.
    
    从以下版本开始:
    
    1
  - copyFrom
```
public static InnerEvent copyFrom(InnerEvent oldInnerEvent)
                           throws CloneNotSupportedException
```
    Creates an InnerEvent by copying task, ID, and other information from an existing InnerEvent.
    
    参数:
    
    oldInnerEvent - Indicates the existing InnerEvent.
    
    返回:
    
    Returns a new InnerEvent object containing the copied data.
    
    抛出:
    
    CloneNotSupportedException - copy event error
    
    从以下版本开始:
    
    3
  - get
```
public static InnerEvent get(int eventId,
                             long param,
                             Object object)
```
    Obtains an InnerEvent instance with the event ID and required data specified.
    
    参数:
    
    eventId - Indicates the ID of the InnerEvent, which is used to identify the event type. You can set it to any int value.
    
    param - Indicates the long integer data carried in this InnerEvent. You can set it to any long value.
    
    object - Indicates the object carried in this InnerEvent.
    
    返回:
    
    Returns an InnerEvent instance.
    
    从以下版本开始:
    
    1
  - get
```
public static InnerEvent get(int eventId)
```
    Obtains an InnerEvent instance with the event ID specified.
    
    参数:
    
    eventId - Indicates the ID of the InnerEvent, which is used to identify the event type. You can set it to any int value.
    
    返回:
    
    Returns an InnerEvent instance.
    
    从以下版本开始:
    
    1
  - get
```
public static InnerEvent get(int eventId,
                             long param)
```
    Obtains an InnerEvent instance with the event ID and long integer data specified.
    
    参数:
    
    eventId - Indicates the ID of the InnerEvent, which is used to identify the event type. You can set it to any int value.
    
    param - Indicates the long integer data carried in this InnerEvent. You can set it to any long value.
    
    返回:
    
    Returns an InnerEvent instance.
    
    从以下版本开始:
    
    1
  - get
```
public static InnerEvent get(int eventId,
                             Object object)
```
    Obtains an InnerEvent instance with the event ID and object specified.
    
    参数:
    
    eventId - Indicates the ID of the InnerEvent, which is used to identify the event type. You can set it to any int value.
    
    object - Indicates the object carried in this InnerEvent.
    
    返回:
    
    Returns an InnerEvent instance.
    
    从以下版本开始:
    
    1
  - get
```
public static InnerEvent get(Runnable task)
```
    Obtains an InnerEvent instance that carries a specified task.
    
    参数:
    
    task - Indicates the Runnable task to be carried. This parameter cannot be null.
    
    返回:
    
    Returns the InnerEvent instance.
    
    从以下版本开始:
    
    4
  - drop
```
public void drop()
```
    Releases an InnerEvent instance.
    The InnerEvent instance cannot be used after being released.
    
    从以下版本开始:
    
    1
  - getHandleTime
```
public long getHandleTime()
```
    Obtains the time when this InnerEvent was delivered. The time is the number of nanoseconds calculated from the time when the device is started to the current time.
    
    返回:
    
    Returns the delivery time of this InnerEvent.
    
    从以下版本开始:
    
    4
  - get
```
public static InnerEvent get(InnerEvent oldInnerEvent)
                      throws CloneNotSupportedException
```
    Clones an InnerEvent instance by copying the event ID, task, owner, and other information of an existing InnerEvent instance to it.
    
    参数:
    
    oldInnerEvent - Indicates the existing InnerEvent whose information is to be copied.
    
    返回:
    
    Returns the InnerEvent instance.
    
    抛出:
    
    CloneNotSupportedException - Throws this exception if the specified object cannot be cloned.
    
    从以下版本开始:
    
    4
  - getPacMap
```
public PacMap getPacMap()
```
    Obtains the PacMap object contained in this InnerEvent or a new PacMap object.
    If the PacMap object is null, this method returns a new PacMap object.
    
    返回:
    
    Returns the PacMap object.
    
    从以下版本开始:
    
    3
  - setPacMap
```
public void setPacMap(PacMap pacMap)
```
    Sets a PacMap object in this InnerEvent.
    
    参数:
    
    pacMap - Indicates the PacMap object to set.
    
    从以下版本开始:
    
    3
  - peekPacMap
```
public PacMap peekPacMap()
```
    Obtains the PacMap object contained in this InnerEvent.
    This method is similar to getPacMap(). The difference is that this method returns null directly, instead of returning a new PacMap object, if the PacMap object in this InnerEvent is null.
    
    返回:
    
    Returns the PacMap object or null.
    
    从以下版本开始:
    
    3
  - getTask
```
public Runnable getTask()
```
    Obtains the Runnable task that will be executed when this InnerEvent is handled.
    
    返回:
    
    Returns the Runnable task if this InnerEvent contains a task; returns null otherwise.
    
    从以下版本开始:
    
    3
  - marshalling
```
public boolean marshalling(Parcel out)
```
    从接口复制的说明: Sequenceable
    
    Marshals this Sequenceable object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object to which the Sequenceable object will be marshaled..
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    从接口复制的说明: Sequenceable
    
    Unmarshals this Sequenceable object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object into which the Sequenceable object has been marshaled.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
    
    从以下版本开始:
    
    4

类 InnerEvent

嵌套类概要

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

字段概要

方法概要

从类继承的方法 java.lang.Object

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

字段详细资料

PRODUCER

eventId

object

param

replyTo

sendingUid

方法详细资料

isPriorityEqual

get

copyFrom

get

get

get

get

get

drop

getHandleTime

get

getPacMap

setPacMap

peekPacMap

getTask

marshalling

unmarshalling

toString