Skip to main content

Owner

open class Owner : Disposable, AutoCloseable, OwnerInterface

Enum of different types of ownership for an object.

BCS

The BCS serialized form for this type is defined by the following ABNF:

owner = owner-address / owner-object / owner-shared / owner-immutable

owner-address = %d00 address
owner-object = %d01 object-id
owner-shared = %d02 u64
owner-immutable = %d03

Functions

NameSummary
addressOrObjectopen override fun addressOrObject(): Address?
Returns an Address if this object is owned by an address or object, and None if it is shared or immutable.
asAddressopen override fun asAddress(): Address
Convert this owner into an address owner if it is one, or panic otherwise
asObjectopen override fun asObject(): ObjectId
Convert this owner into an object owner if it is one, or panic otherwise
asOptAddressopen override fun asOptAddress(): Address?
Convert this owner into an address owner if it is one, or return None otherwise
asOptObjectopen override fun asOptObject(): ObjectId?
Convert this owner into an object owner if it is one, or return None otherwise
asOptSharedopen override fun asOptShared(): Version?
Convert this owner into a shared owner if it is one, or return None otherwise
asSharedopen override fun asShared(): Version
Convert this owner into a shared owner if it is one, or panic otherwise
close@Synchronized
open override fun close()
destroyopen override fun destroy()
equalsopen operator override fun equals(other: Any?): Boolean
hashCodeopen override fun hashCode(): Int
isAddressopen override fun isAddress(): Boolean
Check if this is an address owner
isImmutableopen override fun isImmutable(): Boolean
Check if this is an immutable owner
isObjectopen override fun isObject(): Boolean
Check if this is an object owner
isSharedopen override fun isShared(): Boolean
Check if this is a shared owner
toStringopen override fun toString(): String

Companion object functions

NameSummary
newAddressfun newAddress(address: Address): Owner
newImmutablefun newImmutable(): Owner
newObjectfun newObject(id: ObjectId): Owner
newSharedfun newShared(version: Version): Owner