1 /* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.google.currysrc.api.process; 17 18 import org.eclipse.jdt.core.dom.CompilationUnit; 19 20 /** 21 * The interface for rules. Rules can be matched against a {@link CompilationUnit} and, if applied, 22 * can indicate whether they must have made a modification to be considered successful. 23 */ 24 public interface Rule { 25 26 /** 27 * Returns {@code true} if this rule should be applied to the supplied {@link CompilationUnit}. 28 */ 29 boolean matches(CompilationUnit cu); 30 31 /** 32 * Process the supplied {@link CompilationUnit}. If making changes, Rules must not modify 33 * the {@code compilationUnit} directly: they must request an appropriate tool from the 34 * {@code context}. Only one modification tool can be requested from {@code context}. 35 */ 36 void process(Context context, CompilationUnit cu); 37 38 /** Returns {@code true} if the rule must make a modification to be considered successful. */ 39 boolean mustModify(); 40 } 41
