Coverage Report - org.apache.any23.validator.RuleContext
 
Classes in this File Line Coverage Branch Coverage Complexity
RuleContext
N/A
N/A
1
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  *
 9  
  *  http://www.apache.org/licenses/LICENSE-2.0
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 
 18  
 package org.apache.any23.validator;
 19  
 
 20  
 /**
 21  
  * This context is used to pass data from a {@link Rule}
 22  
  * to a {@link Fix}.
 23  
  *
 24  
  * @see Rule
 25  
  * @author Michele Mostarda (mostarda@fbk.eu)
 26  
  * @author Davide Palmisano (palmisano@fbk.eu)
 27  
  */
 28  
 public interface RuleContext <T> {
 29  
 
 30  
     /**
 31  
      * Puts a data within the context.
 32  
      *
 33  
      * @param name
 34  
      * @param value
 35  
      */
 36  
     void putData(String name, T value);
 37  
 
 38  
     /**
 39  
      * Retrieves a registered object.
 40  
      * 
 41  
      * @param name
 42  
      * @return a registered object, <code>null</code> if not found.
 43  
      */
 44  
     T getData(String name);
 45  
 
 46  
     /**
 47  
      * Removes a data from the context.
 48  
      * 
 49  
      * @param name
 50  
      */
 51  
     void removeData(String name);
 52  
 
 53  
 }