1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * 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, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 */ 19 package org.apache.commons.weaver.spi; 20 21 import org.apache.commons.weaver.lifecycle.WeaveLifecycle; 22 import org.apache.commons.weaver.lifecycle.WeaveLifecycleToken.Clean; 23 import org.apache.commons.weaver.model.Scanner; 24 import org.apache.commons.weaver.model.WeaveEnvironment; 25 26 /** 27 * SPI to provide a means for a weaver module to remove woven classes during incremental builds, if necessary. 28 * Implements the {@code CLEAN} stage of the {@link WeaveLifecycle}. 29 */ 30 public interface Cleaner extends WeaveLifecycleProvider<Clean> { 31 /** 32 * Using the supplied {@link Scanner}, clean a {@link WeaveEnvironment}. 33 * 34 * @param environment to use 35 * @param scanner to use 36 * @return whether any work was done. 37 */ 38 boolean clean(WeaveEnvironment environment, Scanner scanner); 39 }