src/main/gov/nasa/jpf/vm/serialize/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.vm.serialize;
  19
  20
  21 import java.lang.annotation.ElementType;
  22 import java.lang.annotation.Target;
  23
  24 /**
  25  * USE CAREFULLY - Indicates that the stack frame of a method should not,
  26  * in specified ways, be considered during state matching.
  27  *
  28  * This can easily cause the search to be cut off even though the VM has made
  29  * progress, so USE WISELY!
  30  *
  31  * @author peterd
  32  */
  33 @Target({ElementType.METHOD})
  34 public @interface FilterFrame {
  35   /**
  36    * True means locals (incl. parameters) and operand stack will be filtered.
  37    */
  38   boolean filterData() default true;
  39
  40   /**
  41    * True means the location of the next instruction will be filtered.
  42    */
  43   boolean filterPC() default true;
  44
  45   /**
  46    * True means frames below this one will not appear at all in the abstracted
  47    * state.
  48    */
  49   boolean filterSubframes() default true;
  50 }