src/main/gov/nasa/jpf/search/SearchListenerAdapter.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
  19 package gov.nasa.jpf.search;
  20
  21 /**
  22  * The {@code SearchListenerAdapter} abstract class instantiates the methods from {@code SearchListener} in order to create an adapter design pattern.
  23  *
  24  * <p>Any desired methods will require implementing logic in child classes, however unwanted methods can be left uninstantiated in order to aid in
  25  * code readability.
  26  *
  27  *  <p>This class is to be used alongside classes that extend {@code Search} class functionality. {@code SearchListenerAdapter} is capable of gauging
  28  *  Search attributes through the implemented methods and can receive information such as depth, configured properties, and other important {@code Search}
  29  *  attributes.
  30  */
  31 public class SearchListenerAdapter implements SearchListener {
  32
  33   @Override
  34   public void stateAdvanced(Search search) {}
  35
  36   @Override
  37   public void stateProcessed(Search search) {}
  38
  39   @Override
  40   public void stateBacktracked(Search search) {}
  41
  42   @Override
  43   public void statePurged(Search search) {}
  44
  45   @Override
  46   public void stateStored(Search search) {}
  47
  48   @Override
  49   public void stateRestored(Search search) {}
  50
  51   @Override
  52   public void searchProbed(Search search) {}
  53
  54   @Override
  55   public void propertyViolated(Search search) {}
  56
  57   @Override
  58   public void searchStarted(Search search) {}
  59
  60   @Override
  61   public void searchConstraintHit(Search search) {}
  62
  63   @Override
  64   public void searchFinished(Search search) {}
  65
  66 }