WriteLockShutdownHook.java

/*
 * This file is part of dependency-check-core.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Copyright (c) 2017 Jeremy Long. All Rights Reserved.
 */
package org.owasp.dependencycheck.utils;

/**
 * Definition of the shutdown hook used during the unexpected shutdown during
 * the update process of a resources.
 *
 * @author Jeremy Long
 */
@SuppressWarnings("squid:S2134")
public abstract class WriteLockShutdownHook extends Thread {

    /**
     * Adds the shutdown hook.
     *
     * @param lock the Write Lock reference
     */
    public abstract void add(WriteLock lock);

    /**
     * Removes the shutdown hook.
     */
    public abstract void remove();
}