com.github.triceo.robozonky.api.strategies.Recommendation Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017 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.api.strategies;

import java.util.Objects;

import com.github.triceo.robozonky.api.confirmations.ConfirmationProvider;
import com.github.triceo.robozonky.api.remote.entities.Loan;
import com.github.triceo.robozonky.internal.api.Defaults;

/**
 * Represents the decision of the {@link InvestmentStrategy} to recommend a {@link Loan} for investing.
 */
public final class Recommendation {

    private final LoanDescriptor loanDescriptor;
    private final int recommendedInvestmentAmount;
    private final boolean confirmationRequired;

    Recommendation(final LoanDescriptor loanDescriptor, final int amount, final boolean confirmationRequired) {
        if (loanDescriptor == null) {
            throw new IllegalArgumentException("Loan descriptor must not be null.");
        } else if (amount < Defaults.MINIMUM_INVESTMENT_IN_CZK) {
            throw new IllegalArgumentException("Recommended amount must be >= minimum allowed Zonky investment.");
        }
        this.loanDescriptor = loanDescriptor;
        this.recommendedInvestmentAmount = amount;
        this.confirmationRequired = confirmationRequired;
    }

    /**
     * Whether or not a {@link ConfirmationProvider} is required to confirm the decision.
     * @return True if required.
     */
    public boolean isConfirmationRequired() {
        return confirmationRequired;
    }

    /**
     * Describes the loan this recommendation relates to.
     * @return
     */
    public LoanDescriptor getLoanDescriptor() {
        return loanDescriptor;
    }

    /**
     *
     * @return The amount recommended to invest.
     */
    public int getRecommendedInvestmentAmount() {
        return recommendedInvestmentAmount;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        } else if (!(o instanceof Recommendation)) {
            return false;
        }
        final Recommendation that = (Recommendation) o;
        return recommendedInvestmentAmount == that.recommendedInvestmentAmount &&
                confirmationRequired == that.confirmationRequired &&
                Objects.equals(loanDescriptor, that.loanDescriptor);
    }

    @Override
    public int hashCode() {
        return Objects.hash(loanDescriptor, recommendedInvestmentAmount, confirmationRequired);
    }

    @Override
    public String toString() {
        return "Recommendation{" +
                "loanDescriptor=" + loanDescriptor +
                ", recommendedInvestmentAmount=" + recommendedInvestmentAmount +
                ", confirmationRequired=" + confirmationRequired +
                '}';
    }
}