com.github.triceo.robozonky.api.notifications.ExecutionCompletedEvent 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 java.util.Collection;
import java.util.Collections;

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

/**
 * Fired immediately after the investing algorithm is finished making investments.
 */
public final class ExecutionCompletedEvent extends Event {

    private final String username;
    private final Collection investment;
    private final int newBalance;

    public ExecutionCompletedEvent(final String username, final Collection investment,
                                   final int newBalance) {
        this.username = username;
        this.investment = Collections.unmodifiableCollection(investment);
        this.newBalance = newBalance;
    }

    public String getUsername() {
        return this.username;
    }

    /**
     * @return The investments that were made.
     */
    public Collection getInvestments() {
        return this.investment;
    }

    /**
     *
     * @return Account balance at the end of the investing algorithm.
     */
    public int getNewBalance() {
        return this.newBalance;
    }

}