/*
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package jdk.incubator.foreign;
Represents a type which is addressable. An addressable type is one which can be projected down to a memory address instance (see address()
). Examples of addressable types are MemorySegment
, MemoryAddress
, Symbol
and VaList
. API Note: In the future, if the Java language permits, Addressable
may become a sealed
interface, which would prohibit subclassing except by explicitly permitted types, such as MemorySegment
, MemoryAddress
, Symbol
and VaList
. Implementation Requirements:
Implementations of this interface value-based.
/**
* Represents a type which is <em>addressable</em>. An addressable type is one which can be projected down to
* a memory address instance (see {@link #address()}). Examples of addressable types are {@link MemorySegment},
* {@link MemoryAddress}, {@link LibraryLookup.Symbol} and {@link CLinker.VaList}.
*
* @apiNote In the future, if the Java language permits, {@link Addressable}
* may become a {@code sealed} interface, which would prohibit subclassing except by
* explicitly permitted types, such as {@link MemorySegment}, {@link MemoryAddress}, {@link LibraryLookup.Symbol}
* and {@link CLinker.VaList}.
*
* @implSpec
* Implementations of this interface <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
*/
public interface Addressable {
Map this object into a MemoryAddress
instance. Returns: the MemoryAddress
instance associated with this object.
/**
* Map this object into a {@link MemoryAddress} instance.
* @return the {@link MemoryAddress} instance associated with this object.
*/
MemoryAddress address();
}