org.keycloak.models.utils.reflection.PropertyQuery< V > クラステンプレート

org.keycloak.models.utils.reflection.PropertyQuery< V > 連携図

公開メンバ関数
PropertyQuery< V >	addCriteria (PropertyCriteria criteria)
Property< V >	getFirstResult ()
Property< V >	getFirstWritableResult ()
Property< V >	getSingleResult ()
Property< V >	getWritableSingleResult ()
Map< String, Property< V > >	getResultList ()
Map< String, Property< V > >	getWritableResultList ()

関数
	PropertyQuery (Class<?> targetClass)

非公開メンバ関数
Map< String, Property< V > >	getResultList (boolean writable)

非公開変数類
final Class<?>	targetClass
final List< PropertyCriteria >	criteria

詳解

Queries a target class for properties that match certain criteria. A property may either be a private or public field, declared by the target class or inherited from a superclass, or a public method declared by the target class or inherited from any of its superclasses. For properties that are exposed via a method, the property must be a JavaBean style property, i.e. it must provide both an accessor and mutator method according to the JavaBean specification.

This class is not thread-safe, however the result returned by the getResultList() method is.

参照

PropertyQueries

PropertyCriteria

構築子と解体子

PropertyQuery()

org.keycloak.models.utils.reflection.PropertyQuery< V >.PropertyQuery ( Class<?>  targetClass )

inlinepackage

                                        {
        if (targetClass == null) {
            throw new IllegalArgumentException("targetClass parameter may not be null");
        }

        this.targetClass = targetClass;
        this.criteria = new ArrayList<PropertyCriteria>();
    }

関数詳解

addCriteria()

PropertyQuery<V> org.keycloak.models.utils.reflection.PropertyQuery< V >.addCriteria ( PropertyCriteria  criteria )

inline

Add a criteria to query

引数

criteria

the criteria to add

                                                                   {
        this.criteria.add(criteria);
        return this;
    }

getFirstResult()

Property<V> org.keycloak.models.utils.reflection.PropertyQuery< V >.getFirstResult ( )

inline

Get the first result from the query, causing the query to be run.

戻り値

the first result, or null if there are no results

                                        {
        Map<String, Property<V>> results = getResultList();
        return results.isEmpty() ? null : results.values().iterator().next();
    }

getFirstWritableResult()

Property<V> org.keycloak.models.utils.reflection.PropertyQuery< V >.getFirstWritableResult ( )

inline

Get the first result from the query that is not marked as read only, causing the query to be run.

戻り値

the first writable result, or null if there are no results

                                                {
        Map<String, Property<V>>  results = getWritableResultList();
        return results.isEmpty() ? null : results.values().iterator().next();
    }

getResultList() [1/2]

Map<String, Property<V> > org.keycloak.models.utils.reflection.PropertyQuery< V >.getResultList ( )

inline

Get the result from the query, causing the query to be run.

戻り値

the results, or an empty list if there are no results

                                                    {
        return getResultList(false);
    }

getResultList() [2/2]

Map<String, Property<V> > org.keycloak.models.utils.reflection.PropertyQuery< V >.getResultList ( boolean  writable )

inlineprivate

Get the result from the query, causing the query to be run.

引数

writable

if this query should only return properties that are not read only

戻り値

the results, or an empty list if there are no results

                                                                     {
        Map<String, Property<V>> properties = new HashMap<String, Property<V>>();

        // First check public accessor methods (we ignore private methods)
        for (Method method : targetClass.getMethods()) {
            if (!(method.getName().startsWith("is") || method.getName().startsWith("get"))) {
                continue;
            }

            boolean match = true;
            for (PropertyCriteria c : criteria) {
                if (!c.methodMatches(method)) {
                    match = false;
                    break;
                }
            }

            if (match) {
                MethodProperty<V> property = Properties.<V>createProperty(method);

                if (!writable || !property.isReadOnly()) {
                    properties.put(property.getName(), property);
                }
            }
        }

        return Collections.unmodifiableMap(properties);
    }

getSingleResult()

Property<V> org.keycloak.models.utils.reflection.PropertyQuery< V >.getSingleResult ( )

inline

Get a single result from the query, causing the query to be run. An exception is thrown if the query does not return exactly one result.

戻り値

the single result

例外

RuntimeException

if the query does not return exactly one result

                                         {
        Map<String, Property<V>> results = getResultList();
        if (results.size() == 1) {
            return results.values().iterator().next();
        } else if (results.isEmpty()) {
            throw new RuntimeException(
                    "Expected one property match, but the criteria did not match any properties on " +
                            targetClass.getName());
        } else {
            throw new RuntimeException("Expected one property match, but the criteria matched " + results.size() +
                    " properties on " + targetClass.getName());
        }
    }

getWritableResultList()

Map<String, Property<V> > org.keycloak.models.utils.reflection.PropertyQuery< V >.getWritableResultList ( )

inline

Get the non read only results from the query, causing the query to be run.

戻り値

the results, or an empty list if there are no results

                                                            {
        return getResultList(true);
    }

getWritableSingleResult()

Property<V> org.keycloak.models.utils.reflection.PropertyQuery< V >.getWritableSingleResult ( )

inline

Get a single result from the query that is not marked as read only, causing the query to be run. An exception is thrown if the query does not return exactly one result.

戻り値

the single writable result

例外

RuntimeException

if the query does not return exactly one result

                                                 {
        Map<String, Property<V>> results = getWritableResultList();
        if (results.size() == 1) {
            return results.values().iterator().next();
        } else if (results.isEmpty()) {
            throw new RuntimeException(
                    "Expected one property match, but the criteria did not match any properties on " +
                            targetClass.getName());
        } else {
            throw new RuntimeException("Expected one property match, but the criteria matched " +
                    results.size() + " properties on " + targetClass.getName());
        }
    }

メンバ詳解

criteria

final List<PropertyCriteria> org.keycloak.models.utils.reflection.PropertyQuery< V >.criteria

private

targetClass

final Class<?> org.keycloak.models.utils.reflection.PropertyQuery< V >.targetClass

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/utils/reflection/PropertyQuery.java