com.stormpath.sdk.query.Options Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013 Stormpath, Inc.
 *
 * 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.stormpath.sdk.query;

/**
 * An {@code Options} instance represents one or more customizations to apply when retrieving
 * {@link com.stormpath.sdk.resource.Resource Resource}s.
 *
 * @see com.stormpath.sdk.account.AccountOptions AccountOptions
 * @see com.stormpath.sdk.group.GroupOptions GroupOptions
 * @see com.stormpath.sdk.application.ApplicationOptions ApplicationOptions
 * @see com.stormpath.sdk.directory.DirectoryOptions DirectoryOptions
 * @see com.stormpath.sdk.tenant.TenantOptions TenantOptions
 * @since 0.8
 */
public interface Options {

    /**
     * Returns {@code true} if this Options instance is empty (does not contain any options), {@code false} otherwise.
     *
     * @return {@code true} if this Options instance is empty (does not contain any options), {@code false} otherwise.
     */
    boolean isEmpty();
}