org.apache.jena.base.module.SubsystemRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jena-base Show documentation

This module contains non-RDF library code and the common system runtime.

There is a newer version: 5.2.0

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.jena.base.module;

import java.util.List ;
import java.util.ServiceLoader;

/**
 * A {@code JenaSubsystemRegistry} is a set of objects implementing {@link SubsystemLifecycle}.
 *
 */
public interface SubsystemRegistry {

    /** Load - perform some kinds of search for {@link SubsystemLifecycle} implementations.
     * This is called once in the initialization process.
     * 
     * The registry must load object of class T. If using the {@link ServiceLoader}, the
     * registry implementation will need an object of {@code Class}.
     */
    public void load();

    /** Add to the collection. */
    public void add(T module);

    /** check whether registered */
    public boolean isRegistered(T module);

    /** Remove from the collection. */
    public void remove(T module);

    public int size();

    public boolean isEmpty();

    /**
     * Return the registered items in a copied list.
     * The list is detached from the
     * registry and the caller can mutate it.
     * There is no specific ordering requirement.
     */
    public List snapshot();
}