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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 
  25 package jdk.internal.vm.compiler.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  * @since 1.0
  32  */
  33 public interface PointerBase extends ComparableWord {
  34 
  35     /**
  36      * Returns true if this pointer is the {@link WordFactory#nullPointer null pointer}.
  37      *
  38      * @since 1.0
  39      */
  40     boolean isNull();
  41 
  42     /**
  43      * Returns true if this pointer is not the {@link WordFactory#nullPointer null pointer}.
  44      *
  45      * @since 1.0
  46      */
  47     boolean isNonNull();
  48 }