001/*
002 *  This file is part of the Jikes RVM project (http://jikesrvm.org).
003 *
004 *  This file is licensed to You under the Eclipse Public License (EPL);
005 *  You may not use this file except in compliance with the License. You
006 *  may obtain a copy of the License at
007 *
008 *      http://www.opensource.org/licenses/eclipse-1.0.php
009 *
010 *  See the COPYRIGHT.txt file distributed with this work for information
011 *  regarding copyright ownership.
012 */
013package org.vmmagic.pragma;
014
015import java.lang.annotation.Retention;
016import java.lang.annotation.Target;
017import java.lang.annotation.RetentionPolicy;
018import java.lang.annotation.ElementType;
019import org.vmmagic.Pragma;
020
021/**
022 * This pragma is a variant of Pure that is used to mark methods that have a
023 * special behaviour at boot image writing time and are Pure at runtime
024 */
025@Retention(RetentionPolicy.RUNTIME)
026@Target({ElementType.METHOD})
027@Pragma
028public @interface RuntimePure {
029  /** Enumeration of the special boot image return values */
030  enum ReturnValue {
031    /** the return value is unavailable until runtime*/
032    Unavailable
033  }
034  /** @return what value should be returned */
035  ReturnValue value() default ReturnValue.Unavailable;
036}