< prev index next >

src/jdk.incubator.foreign/share/classes/jdk/incubator/foreign/Addressable.java

Print this page

10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package jdk.incubator.foreign;
27 
28 /**
29  * Represents a type which is <em>addressable</em>. An addressable type is one which can be projected down to
30  * a memory address instance (see {@link #address()}). Examples of addressable types are {@link MemorySegment},
31  * {@link MemoryAddress} and {@link CLinker.VaList}.




32  *
33  * @implSpec
34  * Implementations of this interface are <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
35  */
36 public interface Addressable {

37     /**
38      * Map this object into a {@link MemoryAddress} instance.
39      * @return the {@link MemoryAddress} instance associated with this object.
40      */
41     MemoryAddress address();
42 }

10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package jdk.incubator.foreign;
27 
28 /**
29  * Represents a type which is <em>addressable</em>. An addressable type is one which can be projected down to
30  * a {@linkplain #address() memory address}. Examples of addressable types are {@link MemorySegment},
31  * {@link MemoryAddress}, {@link VaList} and {@link NativeSymbol}.
32  * <p>
33  * The {@link Addressable} type is used by the {@link CLinker C linker} to model the types of
34  * {@link CLinker#downcallHandle(FunctionDescriptor) downcall handle} parameters that must be passed <em>by reference</em>
35  * (e.g. memory addresses, va lists and upcall stubs).
36  *
37  * @implSpec
38  * Implementations of this interface are <a href="{@docRoot}/java.base/java/lang/doc-files/ValueBased.html">value-based</a>.
39  */
40 public sealed interface Addressable permits MemorySegment, MemoryAddress, NativeSymbol, VaList {
41 
42     /**
43      * Returns the memory address associated with this addressable.
44      * @return The memory address associated with this addressable.
45      */
46     MemoryAddress address();
47 }
< prev index next >