src/annotations/gov/nasa/jpf/annotation/FilterField.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  * Indicates that a field in the model should not be considered during
  28  * state matching.
  29  * @author peterd
  30  */
  31 @Retention(RetentionPolicy.RUNTIME)
  32 @Target({ElementType.FIELD})
  33 public @interface FilterField {
  34   /**
  35    * If not the empty string, specifies a property that must be "true" to
  36    * activate this filter--unless <code>invert</code> is set.
  37    */
  38   String condition() default "";
  39
  40   /**
  41    * If set to <code>true</code>, property must be "false" to activate filter.
  42    * Does nothing if <code>condition</code> is empty string.
  43    */
  44   boolean invert() default false;
  45 }