MetricGeneratorModule.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.generator;

import com.spotify.heroic.dagger.PrimaryComponent;
import com.spotify.heroic.lifecycle.LifeCycle;
import lombok.Data;

import java.util.Optional;

public interface MetricGeneratorModule {
    Optional<String> id();

    Exposed module(PrimaryComponent primary, Depends depend, String id);

    /**
     * Build an id based on the given index.
     *
     * @param index Index to build id from.
     * @return A module id.
     */
    String buildId(int index);

    /**
     * Dependencies of a generator.
     */
    @Data
    class Depends {
    }

    /**
     * Exposed for a generator.
     */
    interface Exposed {
        Generator generator();

        default LifeCycle life() {
            return LifeCycle.empty();
        }
    }
}