com.microsoft.azure.storage.blob.ContainerAccessConditions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-storage-blob Show documentation

The Azure Storage Java Blob library.

There is a newer version: 11.0.1

/*
 * Copyright Microsoft Corporation
 *
 * 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 com.microsoft.azure.storage.blob;

/**
 * This class contains values which will restrict the successful operation of a variety of requests to the conditions
 * present. These conditions are entirely optional. The entire object or any of its properties may be set to null when
 * passed to a method to indicate that those conditions are not desired. Please refer to the type of each field for more
 * information on those particular access conditions.
 */
public final class ContainerAccessConditions {

    /**
     * An object representing no access conditions.
     */
    public static final ContainerAccessConditions NONE = new ContainerAccessConditions(null,
            null);

    private final HTTPAccessConditions httpAccessConditions;

    private final LeaseAccessConditions leaseID;

    /**
     * Creates a {@link ContainerAccessConditions} object.
     *
     * @param httpAccessConditions
     *      An {@link HTTPAccessConditions} object.
     * @param leaseID
     *      A {@link LeaseAccessConditions} object.
     */
    public ContainerAccessConditions(HTTPAccessConditions httpAccessConditions, LeaseAccessConditions leaseID) {
        this.httpAccessConditions = httpAccessConditions == null ? HTTPAccessConditions.NONE : httpAccessConditions;
        this.leaseID = leaseID == null ? LeaseAccessConditions.NONE : leaseID;
    }

    /**
     * @return
     *      A {@link HTTPAccessConditions} object
     */
    public HTTPAccessConditions getHttpAccessConditions() {
        return httpAccessConditions;
    }

    /**
     * @return
     *      A {@link LeaseAccessConditions} object
     */
    public LeaseAccessConditions getLeaseAccessConditions() {
        return leaseID;
    }
}