001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.commons.weaver.spi; 020 021import org.apache.commons.weaver.lifecycle.WeaveLifecycle; 022import org.apache.commons.weaver.lifecycle.WeaveLifecycleToken.Clean; 023import org.apache.commons.weaver.model.Scanner; 024import org.apache.commons.weaver.model.WeaveEnvironment; 025 026/** 027 * SPI to provide a means for a weaver module to remove woven classes during incremental builds, if necessary. 028 * Implements the {@code CLEAN} stage of the {@link WeaveLifecycle}. 029 */ 030public interface Cleaner extends WeaveLifecycleProvider<Clean> { 031 /** 032 * Using the supplied {@link Scanner}, clean a {@link WeaveEnvironment}. 033 * 034 * @param environment to use 035 * @param scanner to use 036 * @return whether any work was done. 037 */ 038 boolean clean(WeaveEnvironment environment, Scanner scanner); 039}