trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/file/cancel/Cancellation.java

/*
 * 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 org.apache.jackrabbit.oak.segment.file.cancel;

import java.util.Optional;

/**
 * The result of a check for a pending cancellation request.
 */
public class Cancellation {

    private final boolean cancelled;

    private final String reason;

    Cancellation(boolean cancelled, String reason) {
        this.cancelled = cancelled;
        this.reason = reason;
    }

    /**
     * Returns {@code true} if cancellation has been requested, {@code false}
     * otherwise.
     */
    public boolean isCancelled() {
        return cancelled;
    }

    /**
     * If cancellation has been requested (i.e. if {@link #isCancelled()} is
     * {@code true}), returns the reason of the cancellation as provided by the
     * user. Otherwise, an empty {@link Optional} is returned.
     */
    public Optional<String> getReason() {
        return Optional.ofNullable(reason);
    }

}