Docs4dev
Docs
openjdk / 21 / java.base / java / lang / foreign / memorysegment.scope.html

Interface MemorySegment.Scope

Enclosing interface:
MemorySegmentPREVIEW 
public static sealed interface MemorySegment.Scope
Scope is a preview API of the Java platform.
Programs can only use Scope when preview features are enabled.
Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.
A scope models the lifetime of all the memory segments associated with it. That is, a memory segment cannot be accessed if its associated scope is not alive. A new scope is typically obtained indirectly, by creating a new arenaPREVIEW.

Scope instances can be compared for equality. That is, two scopes are considered equals(Object) if they denote the same lifetime.

Method Summary

Modifier and Type Method Description
boolean equals(Object that)
Returns true, if the provided object is also a scope, which models the same lifetime as that modelled by this scope.
int hashCode()
Returns the hash code of this scope object.
boolean isAlive()
Returns true, if the regions of memory backing the memory segments associated with this scope are still valid.

Method Details

isAlive

boolean isAlive()
Returns true, if the regions of memory backing the memory segments associated with this scope are still valid.
Returns:
true, if the regions of memory backing the memory segments associated with this scope are still valid

equals

boolean equals(Object that)
Returns true, if the provided object is also a scope, which models the same lifetime as that modelled by this scope.. In that case, it is always the case that this.isAlive() == ((Scope)that).isAlive().
Overrides:
equals in class Object
Parameters:
that - the object to be tested.
Returns:
true, if the provided object is also a scope, which models the same lifetime as that modelled by this scope
See Also:

hashCode

int hashCode()
Returns the hash code of this scope object.
Overrides:
hashCode in class Object
Implementation Requirements:
Implementations of this method obey the general contract of Object.hashCode().
Returns:
the hash code of this scope object.
See Also:

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/foreign/MemorySegment.Scope.html