1 /*

     2  * Copyright (c) 2013, 2013, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    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 package org.graalvm.word;

    26 

    27 /**

    28  * Marker interface for all {@link WordBase word types} that have the semantic of a pointer (but not

    29  * necessarily all the memory access methods defined in {@link Pointer}).

    30  */

    31 public interface PointerBase extends ComparableWord {

    32 

    33     /**

    34      * Returns true if this pointer is the {@link WordFactory#nullPointer null pointer}.

    35      */

    36     boolean isNull();

    37 

    38     /**

    39      * Returns true if this pointer is not the {@link WordFactory#nullPointer null pointer}.

    40      */

    41     boolean isNonNull();

    42 }