DBFluteMatchers (DBFlute Hamcrest 2.0.0 API)

java.lang.Object
- org.dbflute.testing.DBFluteMatchers

public final class DBFluteMatchers
extends Object

Static factory of custom matchers.

作成者:: taktos

メソッドのサマリー

All Methods Static Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`static <T extends org.dbflute.cbean.ConditionBean> org.dbflute.bhv.readable.CBCall<T>`	`argCB(Class<T> cbclass, Matcher<T> matcher)` Allows creating custom argument matcher that evaluates ConditionBean.
`static <T extends org.dbflute.cbean.ConditionBean> BehaviorArgumentCaptor<T>`	`captor(Class<T> clazz)` Creates a method argument captor.
`static <T extends org.dbflute.cbean.ConditionBean> BehaviorArgumentMatcher<T>`	`cb(Class<T> cbclass, Matcher<T> matcher)` Creates an argument matcher that evaluates ConditionBean.
`static IsColumnExpressed`	`equal(Matcher<?> matcher)` Creates a matcher that matches when the examined column has EQUAL condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`equal(Object value)` A shortcut to `equal(equalTo(value))`.
`static IsColumnExpressed`	`greaterEqual(Matcher<?> matcher)` Creates a matcher that matches when the examined column has GREATER_EQUAL condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`greaterEqual(Object value)` A shortcut to `greaterEqual(equalTo(value))`.
`static IsColumnExpressed`	`greaterThan(Matcher<?> matcher)` Creates a matcher that matches when the examined column has GREATER_THAN condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`greaterThan(Object value)` A shortcut to `greaterThan(equalTo(value))`.
`static <T extends org.dbflute.cbean.ConditionBean> HasCondition<T>`	`hasCondition(String column, Matcher<?> matcher)` Creates a matcher that gets a `ConditionValue` of specified column and pass it to subsequent matcher.
`static <T extends org.dbflute.cbean.ConditionBean> HasRelation<T>`	`hasRelation(String table, HasCondition<T> hasCondition)` Creates a matcher that gets a `ConditionQuery` of specified table and pass it to subsequent matcher.
`static <T extends org.dbflute.cbean.ConditionBean> HasRelation<T>`	`hasRelationCondition(String table, String column, Matcher<?> matcher)` A shortcut to `hasRelation("table", hasCondition("column", ...))`.
`static IsColumnExpressed`	`in(Matcher<?> matcher)` Creates a matcher that matches when the examined column has IN condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`in(Object... items)` A shortcut to `in(hasItems(items))`.
`static IsColumnIsNotNull`	`isNotNull()` Creates a matcher that matches when the examined column has IS_NOT_NULL condition.
`static IsColumnIsNull`	`isNull()` Creates a matcher that matches when the examined column has IS_NULL condition.
`static IsColumnExpressed`	`lessEqual(Matcher<?> matcher)` Creates a matcher that matches when the examined column has LESS_EQUAL condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`lessEqual(Object value)` A shortcut to `lessEqual(equalTo(value))`.
`static IsColumnExpressed`	`lessThan(Matcher<?> matcher)` Creates a matcher that matches when the examined column has GREATER_THAN condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`lessThan(Object value)` A shortcut to `lessThan(equalTo(value))`.
`static IsColumnExpressed`	`like(Matcher<?> matcher)` Creates a matcher that matches when the examined column has LIKE condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`like(Object value)` A shortcut to `like(equalTo(value))`.
`static IsColumnExpressed`	`likeContain(String value)` A shortcut to `like(equalTo("%" + value + "%"))`.
`static IsColumnExpressed`	`likePrefix(String value)` A shortcut to `like(equalTo(value + "%"))`.
`static IsColumnExpressed`	`likeSuffix(String value)` A shortcut to `like(equalTo("%" + value))`.
`static IsColumnExpressed`	`notEqual(Matcher<?> matcher)` Creates a matcher that matches when the examined column has NOT_EQUAL condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`notEqual(Object value)` A shortcut to `notEqual(equalTo(value))`.
`static IsColumnExpressed`	`notIn(Matcher<?> matcher)` Creates a matcher that matches when the examined column has NOT_IN condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`notIn(Object... items)` A shortcut to `notIn(contains(items))`.
`static IsColumnExpressed`	`notLike(Matcher<?> matcher)` Creates a matcher that matches when the examined column has NOT_LIKE condition with value matched with the specified `matcher`.
`static IsColumnExpressed`	`notLike(Object value)` A shortcut to `notLike(equalTo(value))`.
`static IsColumnExpressed`	`notLikeContain(String value)` A shortcut to `notLike(equalTo("%" + value + "%"))`.
`static IsColumnExpressed`	`notLikePrefix(String value)` A shortcut to `notLike(equalTo(value + "%"))`.
`static IsColumnExpressed`	`notLikeSuffix(String value)` A shortcut to `notLike(equalTo("%" + value))`.
`static <T extends org.dbflute.cbean.ConditionBean> ShouldSelect<T>`	`shouldSelect(String columnName)` Creates a matcher that matches if the query selects the column.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

captor
```
public static <T extends org.dbflute.cbean.ConditionBean> BehaviorArgumentCaptor<T> captor(Class<T> clazz)
```
Creates a method argument captor.

型パラメータ:

T - the type of clazz

パラメータ:

clazz - the class of ConditionBean implementation

戻り値:

captor

argCB

public static <T extends org.dbflute.cbean.ConditionBean> org.dbflute.bhv.readable.CBCall<T> argCB(Class<T> cbclass,
                                                                                                   Matcher<T> matcher)

Allows creating custom argument matcher that evaluates ConditionBean.

型パラメータ:: T - the type of clazz
パラメータ:: cbclass - class of ConditionBean implementation; matcher - the matcher to apply to ConditionBean
戻り値:: null
関連項目:: Matchers.argThat(Matcher)

cb

public static <T extends org.dbflute.cbean.ConditionBean> BehaviorArgumentMatcher<T> cb(Class<T> cbclass,
                                                                                        Matcher<T> matcher)

Creates an argument matcher that evaluates ConditionBean.

型パラメータ:: T - the type of clazz
パラメータ:: cbclass - class of ConditionBean implementation; matcher - the matcher to apply to ConditionBean
戻り値:: argument matcher

hasCondition

public static <T extends org.dbflute.cbean.ConditionBean> HasCondition<T> hasCondition(String column,
                                                                                       Matcher<?> matcher)

Creates a matcher that gets a ConditionValue of specified column and pass it to subsequent matcher.

型パラメータ:: T - the type of clazz
パラメータ:: column - the name of column which evaluates; matcher - the matcher that evaluates ConditionValue

hasRelation

public static <T extends org.dbflute.cbean.ConditionBean> HasRelation<T> hasRelation(String table,
                                                                                     HasCondition<T> hasCondition)

Creates a matcher that gets a ConditionQuery of specified table and pass it to subsequent matcher.

型パラメータ:: T - the type of clazz
パラメータ:: table - the name of relating table which evaluates; hasCondition - the matcher that evaluates ConditionQuery

hasRelationCondition

public static <T extends org.dbflute.cbean.ConditionBean> HasRelation<T> hasRelationCondition(String table,
                                                                                              String column,
                                                                                              Matcher<?> matcher)

A shortcut to hasRelation("table", hasCondition("column", ...)).

型パラメータ:: T - the type of clazz
パラメータ:: table - the name of relating table; column - the name of column which evaluates; matcher - the matcher that evaluates ConditionValue

equal
```
public static IsColumnExpressed equal(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has EQUAL condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_Equal("John Doe");
 assertThat(cb, hasCondition("memberName", equal(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

equal

public static IsColumnExpressed equal(Object value)

A shortcut to equal(equalTo(value)).

Example:


 cb.query.setMemberId_Equal(10);
 assertThat(cb, hasCondition("memberId", equal(10)));

パラメータ:: value - the value of condition

notEqual
```
public static IsColumnExpressed notEqual(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has NOT_EQUAL condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_NotEqual("John Doe");
 assertThat(cb, hasCondition("memberName", notEqual(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

notEqual

public static IsColumnExpressed notEqual(Object value)

A shortcut to notEqual(equalTo(value)).

Example:


 cb.query().setMemberId_NotEqual(10);
 assertThat(cb, hasCondition("memberId", notEqual(10)));

パラメータ:: value - the value of condition

greaterThan
```
public static IsColumnExpressed greaterThan(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has GREATER_THAN condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_GreaterThan("John Doe");
 assertThat(cb, hasCondition("memberName", greaterThan(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

greaterThan

public static IsColumnExpressed greaterThan(Object value)

A shortcut to greaterThan(equalTo(value)).

Example:


 cb.query.setMemberId_GreaterThan(10);
 assertThat(cb, hasCondition("memberId", greaterThan(10)));

パラメータ:: value - the value of condition

greaterEqual
```
public static IsColumnExpressed greaterEqual(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has GREATER_EQUAL condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_GreaterEqual("John Doe");
 assertThat(cb, hasCondition("memberName", greaterEqual(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

greaterEqual

public static IsColumnExpressed greaterEqual(Object value)

A shortcut to greaterEqual(equalTo(value)).

Example:


 cb.query.setMemberId_GreaterEqual(10);
 assertThat(cb, hasCondition("memberId", greaterEqual(10)));

パラメータ:: value - the value of condition

lessThan
```
public static IsColumnExpressed lessThan(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has GREATER_THAN condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_LessThan("John Doe");
 assertThat(cb, hasCondition("memberName", lessThan(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

lessThan

public static IsColumnExpressed lessThan(Object value)

A shortcut to lessThan(equalTo(value)).

Example:


 cb.query.setMemberId_LessThan(10);
 assertThat(cb, hasCondition("memberId", lessThan(10)));

パラメータ:: value - the value of condition

lessEqual
```
public static IsColumnExpressed lessEqual(Matcher<?> matcher)
```
Creates a matcher that matches when the examined column has LESS_EQUAL condition with value matched with the specified matcher.
Example:
```
 cb.query.setMemberName_LessEqual("John Doe");
 assertThat(cb, hasCondition("memberName", lessEqual(startsWith("J"))));
 
```
パラメータ:

matcher - a matcher that evaluates the condition value

lessEqual

public static IsColumnExpressed lessEqual(Object value)

A shortcut to lessEqual(equalTo(value)).

Example:


 cb.query.setMemberId_LessEqual(10);
 assertThat(cb, hasCondition("memberId", lessEqual(10)));

パラメータ:: value - the value of condition

in

public static IsColumnExpressed in(Matcher<?> matcher)

Creates a matcher that matches when the examined column has IN condition with value matched with the specified matcher.

Example:


 cb.query().setMemberName_InScope(Arrays.asList("John Doe", "Jane Doe"));
 assertThat(cb, hasCondition("memberName", in(contains("John Doe", "Jane Doe"))));

パラメータ:: matcher - a matcher that evaluates the condition value

in

public static IsColumnExpressed in(Object... items)

A shortcut to in(hasItems(items)).

Example:


 cb.query().setMemberName_InScope(Arrays.asList("John Doe", "Jane Doe"));
 assertThat(cb, hasCondition("memberName", in("John Doe", "Jane Doe")));

パラメータ:: items - the value of condition

notIn

public static IsColumnExpressed notIn(Matcher<?> matcher)

Creates a matcher that matches when the examined column has NOT_IN condition with value matched with the specified matcher.

Example:


 cb.query().setMemberName_NotInScope(Arrays.asList("John Doe", "Jane Doe"));
 assertThat(cb, hasCondition("memberName", notIn(contains("John Doe", "Jane Doe"))));

パラメータ:: matcher - a matcher that evaluates the condition value

notIn

public static IsColumnExpressed notIn(Object... items)

A shortcut to notIn(contains(items)).

Example:


 cb.query().setMemberName_NotInScope(Arrays.asList("John Doe", "Jane Doe"));
 assertThat(cb, hasCondition("memberName", notIn("John Doe", "Jane Doe")));

パラメータ:: items - the value of condition

like

public static IsColumnExpressed like(Matcher<?> matcher)

Creates a matcher that matches when the examined column has LIKE condition with value matched with the specified matcher.

Example:


 cb.query().setMemberName_LikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", like(equalTo("John%"))));

パラメータ:: matcher - a matcher that evaluates the condition value

like

public static IsColumnExpressed like(Object value)

A shortcut to like(equalTo(value)).

Example:


 cb.query().setMemberName_LikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", like("John%")));

パラメータ:: value - the value of condition

likePrefix

public static IsColumnExpressed likePrefix(String value)

A shortcut to like(equalTo(value + "%")).

Example:


 cb.query().setMemberName_LikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", likePrefix("John")));

パラメータ:: value - the value of condition

likeSuffix

public static IsColumnExpressed likeSuffix(String value)

A shortcut to like(equalTo("%" + value)).

Example:


 cb.query().setMemberName_LikeSearch("Doe", op -> op.likeSuffix());
 assertThat(cb, hasCondition("memberName", likeSuffix("Doe")));

パラメータ:: value - the value of condition

likeContain

public static IsColumnExpressed likeContain(String value)

A shortcut to like(equalTo("%" + value + "%")).

Example:


 cb.query().setMemberName_LikeSearch("n D", op -> op.likeContain());
 assertThat(cb, hasCondition("memberName", likeContain("n D")));

パラメータ:: value - the value of condition

notLike

public static IsColumnExpressed notLike(Matcher<?> matcher)

Creates a matcher that matches when the examined column has NOT_LIKE condition with value matched with the specified matcher.

Example:


 cb.query().setMemberName_NotLikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", notLike(equalTo("John%"))));

パラメータ:: matcher - a matcher that evaluates the condition value

notLike

public static IsColumnExpressed notLike(Object value)

A shortcut to notLike(equalTo(value)).

Example:


 cb.query().setMemberName_NotLikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", notLike("John%")));

パラメータ:: value - the value of condition

notLikePrefix

public static IsColumnExpressed notLikePrefix(String value)

A shortcut to notLike(equalTo(value + "%")).

Example:


 cb.query().setMemberName_NotLikeSearch("John", op -> op.likePrefix());
 assertThat(cb, hasCondition("memberName", notLikePrefix("John")));

パラメータ:: value - the value of condition

notLikeSuffix

public static IsColumnExpressed notLikeSuffix(String value)

A shortcut to notLike(equalTo("%" + value)).

Example:


 cb.query().setMemberName_NotLikeSearch("Doe", op -> op.likeSuffix());
 assertThat(cb, hasCondition("memberName", notLikeSuffix("Doe")));

パラメータ:: value - the value of condition

notLikeContain

public static IsColumnExpressed notLikeContain(String value)

A shortcut to notLike(equalTo("%" + value + "%")).

Example:


 cb.query().setMemberName_NotLikeSearch("n D", op -> op.likeContain());
 assertThat(cb, hasCondition("memberName", notLikeContain("n D")));

パラメータ:: value - the value of condition

isNull

public static IsColumnIsNull isNull()

Creates a matcher that matches when the examined column has IS_NULL condition.

Example:


 cb.query.setMemberName_IsNull();
 assertThat(cb, hasCondition("memberName", isNull()));

isNotNull

public static IsColumnIsNotNull isNotNull()

Creates a matcher that matches when the examined column has IS_NOT_NULL condition.

Example:


 cb.query.setMemberName_IsNotNull();
 assertThat(cb, hasCondition("memberName", isNotNull()));

shouldSelect

public static <T extends org.dbflute.cbean.ConditionBean> ShouldSelect<T> shouldSelect(String columnName)

Creates a matcher that matches if the query selects the column. To assert foreign table, join tables with '.' (dot).

Example:


 cb.specify().columnMemberName();
 assertThat(cb, shouldSelect("memberName"));
 
 cb.specify().specifyMemberStatus().columnMemberStatusName();
 assertThat(cb, shouldSelect("memberStatus.memberStatusName"));
 
 cb.specify().specifyMemberServiceAsOne().specifyServiceRank().columnServiceRankName();
 // 'AsOne' can be omitted from table name
 assertThat(cb, shouldSelect("memberService.serviceRank.serviceRankName"));

型パラメータ:: T - the type of clazz
パラメータ:: columnName - the name of column

クラス DBFluteMatchers

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

captor

argCB

cb

hasCondition

hasRelation

hasRelationCondition

equal

equal

notEqual

notEqual

greaterThan

greaterThan

greaterEqual

greaterEqual

lessThan

lessThan

lessEqual

lessEqual

in

in

notIn

notIn

like

like

likePrefix

likeSuffix

likeContain

notLike

notLike

notLikePrefix

notLikeSuffix

notLikeContain

isNull

isNotNull

shouldSelect