Package org.miaixz.bus.gitlab.models

Class EpicFilter

java.lang.Object

org.miaixz.bus.gitlab.models.EpicFilter

All Implemented Interfaces:

Serializable

public class EpicFilter
extends Object
implements Serializable

This class is used to filter Groups when getting lists of epics.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EpicFilter.EpicField

Constructor Summary

Constructors

Constructor	Description
EpicFilter()

Method Summary

Modifier and Type	Method	Description
GitLabApiForm	getQueryParams()	Get the query params specified by this filter.
EpicFilter	withAuthorId(Long authorId)	Add 'author id' filter.
EpicFilter	withAuthorUsername(String authorUsername)	Add 'author username' filter.
EpicFilter	withCreatedAfter(Date createdAfter)	Add 'created after' filter.
EpicFilter	withIncludeAncestorGroups(Boolean includeAncestorGroups)	Add 'include ancestor groups' filter.
EpicFilter	withIncludeDescendantGroups(Boolean includeDescendantGroups)	Add 'include descendant groups' filter.
EpicFilter	withLabels(String labels)	Add 'labels' filter.
EpicFilter	withMyReactionEmoji(String myReactionEmoji)	Add 'my reaction emoji' filter.
EpicFilter	withNot(Map<EpicFilter.EpicField,Object> not)	Add 'not' filter.
EpicFilter	withNot(EpicFilter.EpicField field, Object value)	Add 'not' filter entry.
EpicFilter	withOrderBy(Constants.EpicOrderBy orderBy)	Add 'order by' filter.
EpicFilter	withoutAuthorId(Long authorId)	Add author_id to the 'not' filter entry.
EpicFilter	withoutAuthorUsername(String authorUsername)	Add author_username to the 'not' filter entry.
EpicFilter	withoutLabels(String... labels)	Add labels to the 'not' filter entry.
EpicFilter	withSearch(String search)	Add 'search' filter.
EpicFilter	withSortOrder(Constants.SortOrder sort)	Add 'sort' filter.
EpicFilter	withState(AbstractEpic.EpicState state)	Add 'state' filter.
EpicFilter	withUpdatedAfter(Date updatedAfter)	Add 'updated after' filter.
EpicFilter	withUpdatedBefore(Date updatedBefore)	Add 'updated before' filter.

Methods inherited from class java.lang.Object

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

Constructor Details

EpicFilter

public EpicFilter()

Method Details

withState

public EpicFilter withState(AbstractEpic.EpicState state)

Add 'state' filter.

Parameters:

state - the 'state' filter

Returns:

the reference to this EpicFilter instance

withAuthorId

public EpicFilter withAuthorId(Long authorId)

Add 'author id' filter.

Parameters:

authorId - the author id filter

Returns:

the reference to this EpicFilter instance

withAuthorUsername

public EpicFilter withAuthorUsername(String authorUsername)

Add 'author username' filter.

Parameters:

authorUsername - the 'author username' filter

Returns:

the reference to this EpicFilter instance

withLabels

public EpicFilter withLabels(String labels)

Add 'labels' filter.

Parameters:

labels - the labels filter

Returns:

the reference to this EpicFilter instance

withOrderBy

public EpicFilter withOrderBy(Constants.EpicOrderBy orderBy)

Add 'order by' filter.

Parameters:

orderBy - the 'order by' filter

Returns:

the reference to this GroupFilter instance

withSortOrder

public EpicFilter withSortOrder(Constants.SortOrder sort)

Add 'sort' filter.

Parameters:

sort - sort direction, ASC or DESC

Returns:

the reference to this GroupFilter instance

withSearch

public EpicFilter withSearch(String search)

Add 'search' filter.

Parameters:

search - the 'search' filter

Returns:

the reference to this EpicFilter instance

withCreatedAfter

public EpicFilter withCreatedAfter(Date createdAfter)

Add 'created after' filter.

Parameters:

createdAfter - the 'created after' filter

Returns:

the reference to this EpicFilter instance

withUpdatedAfter

public EpicFilter withUpdatedAfter(Date updatedAfter)

Add 'updated after' filter.

Parameters:

updatedAfter - the 'updated after' filter

Returns:

the reference to this EpicFilter instance

withUpdatedBefore

public EpicFilter withUpdatedBefore(Date updatedBefore)

Add 'updated before' filter.

Parameters:

updatedBefore - the 'updated before' filter

Returns:

the reference to this EpicFilter instance

withIncludeAncestorGroups

public EpicFilter withIncludeAncestorGroups(Boolean includeAncestorGroups)

Add 'include ancestor groups' filter.

Parameters:

includeAncestorGroups - the 'include ancestor groups' filter

Returns:

the reference to this EpicFilter instance

withIncludeDescendantGroups

public EpicFilter withIncludeDescendantGroups(Boolean includeDescendantGroups)

Add 'include descendant groups' filter.

Parameters:

includeDescendantGroups - the 'include descendant groups' filter

Returns:

the reference to this EpicFilter instance

withMyReactionEmoji

public EpicFilter withMyReactionEmoji(String myReactionEmoji)

Add 'my reaction emoji' filter.

Parameters:

myReactionEmoji - the 'my reaction emoji' filter

Returns:

the reference to this EpicFilter instance

withNot

public EpicFilter withNot(Map<EpicFilter.EpicField,Object> not)

Add 'not' filter.

Parameters:

not - the 'not' filter

Returns:

the reference to this EpicFilter instance

withoutAuthorId

public EpicFilter withoutAuthorId(Long authorId)

Add author_id to the 'not' filter entry.

Parameters:

authorId - the id of the author to add to the filter

Returns:

the reference to this EpicFilter instance

withoutAuthorUsername

public EpicFilter withoutAuthorUsername(String authorUsername)

Add author_username to the 'not' filter entry.

Parameters:

authorUsername - the username of the author to add to the filter

Returns:

the reference to this EpicFilter instance

withoutLabels

public EpicFilter withoutLabels(String... labels)

Add labels to the 'not' filter entry.

Parameters:

labels - the labels to add to the filter

Returns:

the reference to this EpicFilter instance

withNot

public EpicFilter withNot(EpicFilter.EpicField field,
 Object value)

Add 'not' filter entry.

Parameters:

field - the field to be added to the 'not' value

value - the value for the entry

Returns:

the reference to this EpicFilter instance

getQueryParams

public GitLabApiForm getQueryParams()

Get the query params specified by this filter.

Returns:

a GitLabApiForm instance holding the query parameters for this GroupFilter instance