com.stormpath.sdk.group.Groups Maven / Gradle / Ivy
/*
* Copyright 2014 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.group;
import com.stormpath.sdk.lang.Classes;
import com.stormpath.sdk.query.Criterion;
import com.stormpath.sdk.query.DateExpressionFactory;
import com.stormpath.sdk.query.EqualsExpressionFactory;
import com.stormpath.sdk.query.StringExpressionFactory;
import java.lang.reflect.Constructor;
/**
* Static utility/helper methods for working with {@link Group} resources. Most methods are
* factory methods used for forming
* Group-specific fluent DSL queries. For example:
*
* Groups.where(Groups.name().containsIgnoreCase("Foo"))
* .and(Groups.status().eq(GroupStatus.ENABLED))
* .orderByName().descending()
* .withAccounts(10, 10)
* .offsetBy(50)
* .limitTo(25));
*
* or, if using static imports:
*
* import static com.stormpath.sdk.group.Groups.*;
*
* ...
*
* where(name().containsIgnoreCase("Foo"))
* .and(status().eq(GroupStatus.ENABLED))
* .orderByName().descending()
* .withAccounts(10, 10)
* .offsetBy(50)
* .limitTo(25));
*
*
* @since 0.8
*/
public final class Groups {
private static final Class BUILDER_CLASS =
Classes.forName("com.stormpath.sdk.impl.group.DefaultCreateGroupRequestBuilder");
//prevent instantiation
private Groups() {
}
/**
* Returns a new {@link GroupOptions} instance, used to customize how one or more {@link Group}s are retrieved.
*
* @return a new {@link GroupOptions} instance, used to customize how one or more {@link Group}s are retrieved.
*/
public static GroupOptions options() {
return (GroupOptions) Classes.newInstance("com.stormpath.sdk.impl.group.DefaultGroupOptions");
}
/**
* Returns a new {@link GroupCriteria} instance to use to formulate a Group 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:
*
* Groups.criteria().add(Groups.name().eqIgnoreCase("Foo"))...
*
* versus:
*
* Groups.where(Groups.name().eqIgnoreCase("Foo"))...
*
* or when using static imports:
*
* where(name().eqIgnoreCase("Foo"))...
*
* While all three statements are equivalent, the second and third examples are shorter and probably more readable.
*
* @return a new {@link GroupCriteria} instance to use to formulate a Group query.
*/
public static GroupCriteria criteria() {
return (GroupCriteria) Classes.newInstance("com.stormpath.sdk.impl.group.DefaultGroupCriteria");
}
/**
* Creates a new {@link GroupCriteria} instance using the specified {@code criterion} as the first query condition.
*
* @return a new {@link GroupCriteria} instance using the specified {@code criterion} as the first query condition.
*/
public static GroupCriteria where(Criterion criterion) {
return criteria().add(criterion);
}
/**
* Creates a new {@link StringExpressionFactory} instance reflecting the Group {@link Group#getName() name}
* property, to be used to construct a name Criterion when building an {@link GroupCriteria} query. For example:
*
* Groups.where(Groups.name().startsWithIgnoreCase("foo");
*
* The above example invokes the returned factory's startsWithIgnoreCase("foo") method. This
* produces a name-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:
*
* GroupCriteria criteria = Groups.criteria();
* StringExpressionFactory nameExpressionFactory = Groups.name();
* Criterion nameStartsWithFoo = nameExpressionFactory.startsWithIgnoreCase("foo");
* criteria.add(nameStartsWithFoo);
*
* The first code example is clearly more succinct and readable.
*
* @return a new {@link Group#getName() name}-specific {@link StringExpressionFactory} instance, to be
* used to construct a criterion when building an {@link GroupCriteria} query.
*/
public static StringExpressionFactory name() {
return newStringExpressionFactory("name");
}
/**
* Creates a new {@link StringExpressionFactory} instance reflecting the Group {@link Group#getDescription() description}
* property, to be used to construct a description Criterion when building an {@link GroupCriteria} query. For example:
*
* Groups.where(Groups.description().startsWithIgnoreCase("foo");
*
* The above example invokes the returned factory's startsWithIgnoreCase("foo") method. This
* produces a description-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:
*
* GroupCriteria criteria = Groups.criteria();
* StringExpressionFactory descriptionExpressionFactory = Groups.description();
* Criterion descriptionStartsWithFoo = descriptionExpressionFactory.startsWithIgnoreCase("foo");
* criteria.add(descriptionStartsWithFoo);
*
* The first code example is clearly more succinct and readable.
*
* @return a new {@link Group#getDescription() description}-specific {@link StringExpressionFactory} instance, to be
* used to construct a criterion when building an {@link GroupCriteria} query.
*/
public static StringExpressionFactory description() {
return newStringExpressionFactory("description");
}
/**
* Creates a new {@link EqualsExpressionFactory} instance reflecting the Group {@link Group#getStatus() status}
* property, to be used to construct a status Criterion when building an {@link GroupCriteria} query. For example:
*
* Groups.where(Groups.status().eq(GroupStatus.ENABLED);
*
* The above example invokes the returned factory's eq() method. This
* produces a status-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:
*
* GroupCriteria criteria = Groups.criteria();
* StringExpressionFactory statusExpressionFactory = Groups.status();
* Criterion statusEqualsEnabled = statusExpressionFactory.eq(GroupStatus.ENABLED);
* criteria.add(statusEqualsEnabled);
*
* The first code example is clearly more succinct and readable.
*
* @return a new {@link Group#getStatus() status}-specific {@link StringExpressionFactory} instance, to be
* used to construct a criterion when building an {@link GroupCriteria} query.
*/
public static EqualsExpressionFactory status() {
return newEqualsExpressionFactory("status");
}
/**
* Creates a new {@link com.stormpath.sdk.group.CreateGroupRequestBuilder CreateGroupRequestBuilder}
* instance reflecting the specified {@link com.stormpath.sdk.group.Group} instance. The builder can be used to customize any
* creation request options as necessary.
*
* @param group the group to create a new record for within Stormpath
* @return a new {@link com.stormpath.sdk.group.CreateGroupRequestBuilder CreateGroupRequestBuilder}
* instance reflecting the specified {@link com.stormpath.sdk.group.Group} instance.
* @see com.stormpath.sdk.application.Application#createGroup(CreateGroupRequest)
* @since 0.9
*/
public static CreateGroupRequestBuilder newCreateRequestFor(Group group) {
Constructor ctor = Classes.getConstructor(BUILDER_CLASS, Group.class);
return (CreateGroupRequestBuilder) Classes.instantiate(ctor, group);
}
private static StringExpressionFactory newStringExpressionFactory(String propName) {
final String FQCN = "com.stormpath.sdk.impl.query.DefaultStringExpressionFactory";
return (StringExpressionFactory) Classes.newInstance(FQCN, propName);
}
private static EqualsExpressionFactory newEqualsExpressionFactory(String propName) {
final String FQCN = "com.stormpath.sdk.impl.query.DefaultEqualsExpressionFactory";
return (EqualsExpressionFactory) Classes.newInstance(FQCN, propName);
}
/**
* Creates a new {@link DateExpressionFactory} instance reflecting the Group {@link Group#getCreatedAt() createdAt}
* property, to be used to construct a createdAt Criterion when building an {@link GroupCriteria} query. For example:
*
* Groups.where(Groups.createdAt().matches("[,2014-04-05T12:00:00]");
*
* The above example invokes the returned factory's matches("[,2014-04-05T12:00:00]")) method. This
* produces a name-specific {@link Criterion} which is added to the criteria query (via the
* {@link #where(Criterion) where} method).
*
* For example, the following code is equivalent:
*
* GroupCriteria criteria = Groups.criteria();
* DateExpressionFactory createdAt = Groups.createdAt();
* Criterion createdAtMatches = createdAt.matches("[,2014-04-05T12:00:00]");
* criteria.add(createdAtMatches);
*
*
* @return a new {@link Group#getCreatedAt() createdAt}-specific {@link DateExpressionFactory} instance, to be
* used to construct a criterion when building an {@link GroupCriteria} query.
* @since 1.0.RC4.6
*/
public static DateExpressionFactory createdAt(){
return newDateExpressionFactory("createdAt");
}
/**
* Creates a new {@link DateExpressionFactory} instance reflecting the Group {@link Group#getModifiedAt() modifiedAt}
* property, to be used to construct a modifiedAt Criterion when building an {@link GroupCriteria} query. For example:
*
* Groups.where(Groups.modifiedAt().matches("[,2014-04-05T12:00:00]");
*
* The above example invokes the returned factory's matches("[,2014-04-05T12:00:00]")) method. This
* produces a name-specific {@link Criterion} which is added to the criteria query (via the
* {@link #where(Criterion) where} method).
*
* For example, the following code is equivalent:
*
* GroupCriteria criteria = Groups.criteria();
* DateExpressionFactory createdAt = Groups.modifiedAt();
* Criterion modifiedAtMatches = modifiedAt.matches("[,2014-04-05T12:00:00]");
* criteria.add(modifiedAtMatches);
*
*
* @return a new {@link Group#getModifiedAt() modifiedAt}-specific {@link DateExpressionFactory} instance, to be
* used to construct a criterion when building an {@link GroupCriteria} query.
* @since 1.0.RC4.6
*/
public static DateExpressionFactory modifiedAt(){
return newDateExpressionFactory("modifiedAt");
}
private static DateExpressionFactory newDateExpressionFactory(String propName) {
final String FQCN = "com.stormpath.sdk.impl.query.DefaultDateExpressionFactory";
return (DateExpressionFactory) Classes.newInstance(FQCN, propName);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy