org.spongepowered.api.advancement.Progressable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation

A plugin API for Minecraft: Java Edition

The newest version!

/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.api.advancement;

import java.time.Instant;
import java.util.Optional;

/**
 * Represents the status that is achieved or is in
 * the process of being achieved.
 */
public interface Progressable {

    /**
     * Gets whether this {@link Progressable} is achieved.
     *
     * @return Is achieved
     */
    default boolean achieved() {
        return this.get().isPresent();
    }

    /**
     * Gets the time that the {@link Progressable} was
     * achieved if present.
     *
     * @return The achieving time, if present
     */
    Optional get();

    /**
     * Grants this {@link Progressable}, if achieved before
     * that time will be returned.
     *
     * @return The achieving time
     */
    Instant grant();

    /**
     * Revokes the {@link Progressable} status. The time that the {@link Progressable}
     * was achieved before will be returned if present.
     *
     * @return The previous achieving time, if present
     */
    Optional revoke();

}