RevisionLockResult.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.nifi.web.revision;

public enum RevisionLockResult {

    /**
     * A lock was obtained for all Revisions for which a lock was requested.
     */
    LOCK_OBTAINED(true),

    /**
     * No lock was obtained because one or more of the Revisions was not up to date.
     */
    INVALID_REVISION(false);



    private final boolean successful;

    private RevisionLockResult(final boolean successful) {
        this.successful = successful;
    }

    /**
     * Indicates whether or not the result provides a successful lock
     *
     * @return <code>true</code> if a lock was successfully obtained, <code>false</code> otherwise
     */
    public boolean isSuccess() {
        return successful;
    }
}