computer-driver/src/main/java/com/baidu/hugegraph/computer/driver/JobState.java

/*
 * Copyright 2017 HugeGraph Authors
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to You 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.baidu.hugegraph.computer.driver;


public interface JobState {

    /**
     * @return The current superstep of the job.
     */
    int superstep();

    /**
     * @return The max superstep of the job.
     */
    int maxSuperstep();

    /**
     * @return The last superstep stat. The user may need the stat to
     * analysis the job.
     */
    SuperstepStat lastSuperstepStat();

    /**
     * @return The current job status.
     */
    JobStatus jobStatus();
}