oracle.javatools.db.property

Class PropertyCriteria

java.lang.Object

oracle.javatools.db.property.PropertyCriteria

All Implemented Interfaces:

java.util.function.Predicate<PropertyInfo>

public final class PropertyCriteria
extends java.lang.Object
implements java.util.function.Predicate<PropertyInfo>

Criteria class that restricts the lookup of property information from the metadata. A PropertyCriteria is a simple Predicate, but the specification of whether "bean" and/or "extra" properties are required is used by the Metadata to avoid unnecessarily loading.

For the built-in Boolean criteria, the value from the PropertyInfo must match the criteria value. For example with the "derived" criteria:

• Boolean.TRUE - will only match derived properties
• Boolean.FALSE - will only match non-derived properties
• null - will match properties regardless of derived status

Since:

12.2.1

Constructor Summary

Constructors

Constructor and Description
PropertyCriteria() Creates a PropertyCriteria that by default excludes deprecated and internal properties.

Method Summary

Modifier and Type	Method and Description
void	addPredicate(java.util.function.Predicate<PropertyInfo> predicate) Adds an extra criteria in the form of a predicate.
static PropertyCriteria	createEmptyCriteria() Creates an explictly empty criteria that allows all properties.
void	setDeprecated(java.lang.Boolean deprecated) Sets the deprecated criteria - i.e.
void	setDerived(java.lang.Boolean derived) Sets the derived criteria - i.e.
void	setIncludeBean(boolean includeBean) Sets the bean property criteria - i.e whether to include properties that are defined on the bean.
void	setIncludeExtra(boolean includeExtra) Sets the extra property criteria - i.e whether to include properties that are not defined on the bean, but are extra properties registered by the metadata.
void	setInternal(java.lang.Boolean internal) Sets the internal criteria - i.e.
boolean	test(PropertyInfo info)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

PropertyCriteria

public PropertyCriteria()

Creates a PropertyCriteria that by default excludes deprecated and internal properties.

See Also:

createEmptyCriteria()

Method Detail

setDerived

public void setDerived(java.lang.Boolean derived)

Sets the derived criteria - i.e. whether to match properties that are specifically derived, or not derived.

Parameters:

derived - true to only include deprecated properties, false to only include non-derived properties.

setDeprecated

public void setDeprecated(java.lang.Boolean deprecated)

Sets the deprecated criteria - i.e. whether to match properties that are specifically deprecated, or not deprecated. This is Boolean.FALSE by default (i.e. deprecated properties will not be included).

Parameters:

deprecated - null to include deprecated properties, true to only include deprecated properties

setInternal

public void setInternal(java.lang.Boolean internal)

Sets the internal criteria - i.e. whether to match properties that are specifically internal, or not internal. This is Boolean.FALSE by default (i.e. internal properties will not be included).

Parameters:

internal - null to include internal properties, true to only include internal properties

setIncludeBean

public void setIncludeBean(boolean includeBean)

Sets the bean property criteria - i.e whether to include properties that are defined on the bean. This is true by default.

Parameters:

includeBean - false to exclude bean properties

setIncludeExtra

public void setIncludeExtra(boolean includeExtra)

Sets the extra property criteria - i.e whether to include properties that are not defined on the bean, but are extra properties registered by the metadata. This is true by default.

Parameters:

includeExtra - false to exclude extra properties

addPredicate

public void addPredicate(java.util.function.Predicate<PropertyInfo> predicate)

Adds an extra criteria in the form of a predicate.

Parameters:

predicate - an extra criteria test that each PropertyInfo must match.

test

public boolean test(PropertyInfo info)

Specified by:

test in interface java.util.function.Predicate<PropertyInfo>

createEmptyCriteria

public static PropertyCriteria createEmptyCriteria()

Creates an explictly empty criteria that allows all properties. The default constructor applies sensible defaults, which this removes.

Returns:

an empty criteria.