com.stormpath.sdk.application.ApplicationAccountStoreMappings 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.application;

import com.stormpath.sdk.lang.Classes;
import com.stormpath.sdk.query.Criterion;
import com.stormpath.sdk.query.EqualsExpressionFactory;

/**
 * Static utility/helper methods for working with {@link ApplicationAccountStoreMapping ApplicationAccountStoreMapping} resources.  Most methods are
 * factory methods used for forming
 * ApplicationAccountStoreMapping-specific fluent DSL queries. for example:
 *  * ApplicationAccountStoreMappings.criteria()
 *     .withApplication()
 *     .offsetBy(50)
 *     .limitTo(25));
 * 
 * or
 *  * ApplicationAccountStoreMappings.where(ApplicationAccountStoreMappings.listIndex().eq(3))
 *     .withAccountStore()
 * 
 * or, if using static imports:
 *  * import static com.stormpath.sdk.account.ApplicationAccountStoreMappings.*;
 *
 * ...
 *     criteria()
 *     .withApplication()
 *     .offsetBy(50)
 *     .limitTo(25));
 * 
 * or
 *  * import static com.stormpath.sdk.account.ApplicationAccountStoreMappings.*;
 *
 * ...
 *
 * where(listIndex().eq(3))
 *     .withAccountStore()
 * 
 * 
 * 
 * @since 0.9
 */
public final class ApplicationAccountStoreMappings {

    /**
     * Returns a new {@link ApplicationAccountStoreMappingOptions} instance, used to customize how one or more {@link ApplicationAccountStoreMapping ApplicationAccountStoreMapping}s are retrieved.
     *
     * @return a new {@link ApplicationAccountStoreMappingOptions} instance, used to customize how one or more {@link ApplicationAccountStoreMapping ApplicationAccountStoreMapping}s are retrieved.
     */
    public static ApplicationAccountStoreMappingOptions options() {
        return (ApplicationAccountStoreMappingOptions) Classes.newInstance("com.stormpath.sdk.impl.application.DefaultAccountStoreMappingOptions");
    }

    /**
     * Returns a new {@link ApplicationAccountStoreMappingCriteria} instance to use to formulate an Account query.
     * 
     * Note that it is usually more common to use the {@link #where(com.stormpath.sdk.query.Criterion) where} method
     * instead of this one as the {@code where} method usually lends to better readability.  For example:
     * 
     * ApplicationAccountStoreMappings.criteria().add(ApplicationAccountStoreMappings.listIndex().eq(8))...
     * 
     * versus:
     *      * ApplicationAccountStoreMappings.where(ApplicationAccountStoreMappings.listIndex().eq(8))...
     * 
     * or when using static imports:
     *      * where(listIndex().eq(8))...
     * 
     * While all three statements are equivalent, the second and third examples are shorter and probably more readable.
     *
     * @return a new {@link ApplicationAccountStoreMappingCriteria} instance to use to formulate an ApplicationAccountStoreMapping query.
     */
    public static ApplicationAccountStoreMappingCriteria criteria() {
        return Classes.newInstance("com.stormpath.sdk.impl.application.DefaultApplicationAccountStoreMappingCriteria");
    }

    /**
     * Creates a new {@link ApplicationAccountStoreMappingCriteria} instance using the specified {@code criterion} as the first query condition.
     *
     * @return a new {@link ApplicationAccountStoreMappingCriteria} instance using the specified {@code criterion} as the first query condition.
     */
    public static ApplicationAccountStoreMappingCriteria where(Criterion criterion) {
        return criteria().add(criterion);
    }

    /**
     * Creates a new {@link EqualsExpressionFactory} instance reflecting the ApplicationAccountStoreMappings {@link ApplicationAccountStoreMapping#getListIndex() listIndex}
     * property, to be used to construct a listIndex Criterion when building an {@link ApplicationAccountStoreMappingCriteria} query.  For example:
     *      * ApplicationAccountStoreMappings.where(ApplicationAccountStoreMappings.listIndex().eq(12);
     * 
     * The above example invokes the returned factory's eq() method.  This
     * produces a listIndex-specific {@link Criterion} which is added to the criteria query (via the
     * {@link #where(com.stormpath.sdk.query.Criterion) where} method).  For example, the following code is equivalent:
     *      * ApplicationAccountStoreMappingCriteria criteria = ApplicationAccountStoreMappings.criteria();
     * EqualsExpressionFactory listIndexExpressionFactory = ApplicationAccountStoreMappings.listIndex();
     * Criterion listIndexEqualsTen = listIndexExpressionFactory.eq(10);
     * criteria.add(listIndexEqualsEnabled);
     * 
     * The first code example is clearly more succinct and readable.
     *
     * @return a new {@link ApplicationAccountStoreMapping#getListIndex() listIndex}-specific {@link EqualsExpressionFactory} instance, to be
     *         used to construct a criterion when building an {@link ApplicationAccountStoreMappingCriteria} query.
     */
    public static EqualsExpressionFactory listIndex() {
        return newEqualsExpressionFactory("listIndex");
    }

    private static EqualsExpressionFactory newEqualsExpressionFactory(String propName) {
        final String FQCN = "com.stormpath.sdk.impl.query.DefaultEqualsExpressionFactory";
        return (EqualsExpressionFactory) Classes.newInstance(FQCN, propName);
    }
}