src/annotations/gov/nasa/jpf/annotation/FilterFrame.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.annotation;
  19
  20
  21 import java.lang.annotation.ElementType;
  22 import java.lang.annotation.Retention;
  23 import java.lang.annotation.RetentionPolicy;
  24 import java.lang.annotation.Target;
  25
  26 /**
  27  * USE CAREFULLY - Indicates that the stack frame of a method should not,
  28  * in specified ways, be considered during state matching.
  29  *
  30  * This can easily cause the search to be cut off even though the VM has made
  31  * progress, so USE WISELY!
  32  *
  33  * @author peterd
  34  */
  35 @Retention(RetentionPolicy.RUNTIME)
  36 @Target({ElementType.METHOD})
  37 public @interface FilterFrame {
  38   /**
  39    * True means locals (incl. parameters) and operand stack will be filtered.
  40    */
  41   boolean filterData() default true;
  42
  43   /**
  44    * True means the location of the next instruction will be filtered.
  45    */
  46   boolean filterPC() default true;
  47
  48   /**
  49    * True means frames below this one will not appear at all in the abstracted
  50    * state.
  51    */
  52   boolean filterSubframes() default true;
  53 }