/*

 * 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.

 *

 * 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.internal.vm.compiler.word;

/**

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

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

 *

 * @since 19.0

 */

public interface PointerBase extends ComparableWord {

    /**

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

     *

     * @since 19.0

     */

    boolean isNull();

    /**

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

     *

     * @since 19.0

     */

    boolean isNonNull();

}