org.lastaflute.job.subsidiary.RunnerResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lasta-job Show documentation
Job Scheduling for LastaFlute
There is a newer version: 2.0.0
/*
 * Copyright 2015-2017 the original author or authors.
 *
 * 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 org.lastaflute.job.subsidiary;

import java.time.LocalDateTime;

import org.dbflute.optional.OptionalThing;

/**
 * @author jflute
 * @since 0.2.7 (2017/02/22 Wednesday)
 */
public class RunnerResult {

    // ===================================================================================
    //                                                                           Attribute
    //                                                                           =========
    protected final OptionalThing beginTime; // not null, empty allowed if cannot begin
    protected OptionalThing endTime = OptionalThing.empty(); // not null, empty allowed if cannot begin or not loaded yet
    protected final OptionalThing endTitleRoll; // not null, empty allowed
    protected final OptionalThing cause; // null allowed, already handled (e.g. logging)
    protected final boolean nextTriggerSuppressed; // by runtime
    protected final boolean quitByConcurrent; // by runner

    // ===================================================================================
    //                                                                         Constructor
    //                                                                         ===========
    protected RunnerResult(OptionalThing beginTime, OptionalThing endTitleRoll, OptionalThing cause,
            boolean nextTriggerSuppressed, boolean quitByConcurrent) {
        this.beginTime = beginTime;
        this.endTitleRoll = endTitleRoll;
        this.cause = cause;
        this.nextTriggerSuppressed = nextTriggerSuppressed;
        this.quitByConcurrent = quitByConcurrent;
    }

    public static RunnerResult asExecuted(LocalDateTime beginTime, OptionalThing endTitleRoll, OptionalThing cause,
            boolean nextTriggerSuppressed) {
        return new RunnerResult(OptionalThing.of(beginTime), endTitleRoll, cause, nextTriggerSuppressed, false);
    }

    public static RunnerResult asQuitByConcurrent() {
        return new RunnerResult(OptionalThing.empty(), OptionalThing.empty(), OptionalThing.empty(), false, true);
    }

    public RunnerResult acceptEndTime(LocalDateTime endTime) { // because hard to get current time in job runner
        this.endTime = OptionalThing.of(endTime);
        return this;
    }

    // ===================================================================================
    //                                                                      Basic Override
    //                                                                      ==============
    @Override
    public String toString() {
        return "result:{begin=" + beginTime + ", endTitleRoll=" + endTitleRoll.isPresent() + ", cause=" + cause.isPresent() + "}";
    }

    // ===================================================================================
    //                                                                            Accessor
    //                                                                            ========
    public OptionalThing getBeginTime() {
        return beginTime;
    }

    public OptionalThing getEndTime() {
        return endTime;
    }

    public OptionalThing getEndTitleRoll() {
        return endTitleRoll;
    }

    public OptionalThing getCause() {
        return cause;
    }

    public boolean isNextTriggerSuppressed() {
        return nextTriggerSuppressed;
    }

    public boolean isQuitByConcurrent() {
        return quitByConcurrent;
    }
}