org.opendaylight.infrautils.ready.order.FunctionalityReadyNotifier Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017 Red Hat, Inc. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.infrautils.ready.order;

/**
 * Service to register {@link FunctionalityReady} markers.
 *
 * @author Michael Vorburger.ch
 * @deprecated Callers of {@link #register(Class)} should be refactored to call {@code ComponentFactory.newInstance()}
 *             instead.
 */
@Deprecated(since = "6.0.9", forRemoval = true)
public interface FunctionalityReadyNotifier {
    /**
     * Register a {@link FunctionalityReady} marker.
     *
     * @param markerInterface
     *            the marker FunctionalityReady marker interface
     * @return the {@link FunctionalityReadyRegistration} which allows to
     *         {@link FunctionalityReadyRegistration#unregister()} the marker
     * @see FunctionalityReady
     */
     FunctionalityReadyRegistration register(Class markerInterface);
}