com.github.triceo.robozonky.api.notifications.InvestmentMadeEvent 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.notifications;

import com.github.triceo.robozonky.api.remote.entities.Investment;

/**
 * Fired immediately after an investment was submitted to the API. Will not be fired in case of a dry run.
 */
public final class InvestmentMadeEvent extends Event {

    private final Investment investment;
    private final int finalBalance;
    private final boolean dryRun;

    public InvestmentMadeEvent(final Investment investment, final int finalBalance, final boolean isDryRun) {
        this.investment = investment;
        this.finalBalance = finalBalance;
        this.dryRun = isDryRun;
    }

    @Deprecated
    public InvestmentMadeEvent(final Investment investment, final int finalBalance) {
        this(investment, finalBalance, false);
    }

    /**
     * @return The investment that was made.
     */
    public Investment getInvestment() {
        return this.investment;
    }

    /**
     * @return The new account finalBalance
     */
    public int getFinalBalance() {
        return this.finalBalance;
    }

    /**
     *
     * @return True if investment was only simulated.
     */
    public boolean isDryRun() {
        return dryRun;
    }

}