HeroicModule.java

/*
 * Copyright (c) 2015 Spotify AB.
 *
 * 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 com.spotify.heroic;

import com.google.common.collect.ImmutableList;
import com.spotify.heroic.dagger.LoadingComponent;

import java.util.List;

/**
 * The entry point for heroic modules.
 * <p>
 * Modules are structurally separated from the core of Heroic to encourage isolation.
 */
public interface HeroicModule {
    /**
     * Setup the module.
     *
     * @param loading Loading dependencies which are available to modules.
     * @return a runnable that when run will configure the module.
     */
    Runnable setup(LoadingComponent loading);

    /**
     * Get parameters associated with the module.
     *
     * @return a list of parameter specifications.
     */
    default List<ParameterSpecification> parameters() {
        return ImmutableList.of();
    }
}