com.github.triceo.robozonky.strategy.InvestmentStrategyService Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 Lukáš Petrovický
 *
 * 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.
 */

package com.github.triceo.robozonky.strategy;

import java.io.File;
import java.util.ServiceLoader;

/**
 * Use Java's {@link ServiceLoader} to load strategy different strategy implementations.
 */
public interface InvestmentStrategyService {

    /**
     * Whether or not this particular file type is supported.
     *
     * @param strategyFile Investment strategy in question.
     * @return True if the strategy service knows of a provider for this particular file type.
     */
    boolean isSupported(File strategyFile);

    /**
     * Prepare the investment strategy for being used by the app. Will only be called if {@link #isSupported(File)}
     * returned true.
     *
     * @param strategyFile Investment strategy in question.
     * @return Processed instance of the investment strategy provided by the user.
     * @throws InvestmentStrategyParseException If the strategy file failed to parse.
     */
    InvestmentStrategy parse(File strategyFile) throws InvestmentStrategyParseException;

}